Swagger 常用注解
@GetMapping("/findAll/{index}/{limit}")
@ApiOperation("菜单分页查询接口")
public List<Menu> findall(@PathVariable("index") int index,@PathVariable("limit") int limit){
return menuRepository.findAll(index,limit);
}
@ApiModel("这是Menu菜单,它的属性有")
public class Menu {
private int id;
private String name;
private Double price;
private String flavor;
private int type_id;
}
@Api
用在Controller上面说明Controller的信息
@Api("这是菜单的Controller")
@RestController
@RequestMapping("/menu")
public class MenuController {}
@ApiModelProperty
用在参数上说明参数的详细信息
@ApiModel("这是Menu菜单,它的属性有")
public class Menu {
@ApiModelProperty("菜单id")
private int id;
@ApiModelProperty("菜单名")
private String name;
@ApiModelProperty("价格")
private Double price;
@ApiModelProperty("口味")
private String flavor;
}
@ApiImplicitParams
方法参数的详细说明
@GetMapping("/findAll/{index}/{limit}")
@ApiOperation("菜单分页查询接口")
@ApiImplicitParams({
@ApiImplicitParam(name = "index",value = "第几页"),
@ApiImplicitParam(name = "limit",value = "每页的大小")
})
public List<Menu> findall(@PathVariable("index") int index,@PathVariable("limit") int limit){
return menuRepository.findAll(index,limit);
}
@PostMapping("/test1")
@ApiResponses({
@ApiResponse(code=400,message = "参数不正确"),
@ApiResponse(code=500,message = "服务器错误")
})
public void test1(){}