swagger返回map字段註釋

1.效果圖如下:

2.controller層代碼:



import java.util.HashMap;
import java.util.Map;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.mengyoou.core.serialize.ResponseMsg;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;


@Api(value="返回字段添加註釋信息controller",tags={"返回字段添加註釋信息controller"})
@RestController
public class TestController {

	@ApiOperation(value="返回字段添加註釋信息", notes="返回字段添加註釋信息")
    @RequestMapping(value={"demo"}, method={RequestMethod.GET})
    @ApiResponses({
    	@ApiResponse(code = 200, message = "ok", response=User.class),
    })
    public ResponseMsg demo() {
    	User user = new User();
    	Map<String, Object> map = new HashMap<>();
    	map.put("user", user);
    	return new ResponseMsg(map);
    }

}

 

3.用戶實體的代碼:



import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;


@ApiModel(value="登錄成功後返回的個人信息")
@Data
public class User {
	
	    @ApiModelProperty(value="用戶名")
	    private String userName;//用戶名
	    @ApiModelProperty(value="密碼")
	    private String password;//用戶名

}

4.關鍵點:

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章