swagger注释API详细说明

时间：2022-04-23 07:40:33

API详细说明

注释汇总

swagger注释API详细说明

@RequestMapping此注解的推荐配置 
value 
method 
produces

示例：

    @ApiOperation("信息软删除")

    @ApiResponses({ @ApiResponse(code = CommonStatus.OK, message = "操作成功"),

            @ApiResponse(code = CommonStatus.EXCEPTION, message = "服务器内部异常"),

            @ApiResponse(code = CommonStatus.FORBIDDEN, message = "权限不足") })

    @ApiImplicitParams({ @ApiImplicitParam(paramType = "query", dataType = "Long", name = "id", value = "信息id", required = true) })

    @RequestMapping(value = "/remove.json", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

    public RestfulProtocol remove(Long id) {
　　　　 @ApiModelProperty(value = "标题")

    　　private String  title;
　　}

@ApiImplicitParam

swagger注释API详细说明

paramType 示例详解

path

@RequestMapping(value = "/findById1/{id}", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

 @PathVariable(name = "id") Long id

body

@ApiImplicitParams({ @ApiImplicitParam(paramType = "body", dataType = "MessageParam", name = "param", value = "信息参数", required = true) })

  @RequestMapping(value = "/findById3", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_UTF8_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)

  @RequestBody MessageParam param

  提交的参数是这个对象的一个json，然后会自动解析到对应的字段上去，也可以通过流的形式接收当前的请求数据，但是这个和上面的接收方式仅能使用一个（用@RequestBody之后流就会关闭了）

header

@ApiImplicitParams({ @ApiImplicitParam(paramType = "header", dataType = "Long", name = "id", value = "信息id", required = true) })

String idstr = request.getHeader("id");

if (StringUtils.isNumeric(idstr)) {

id = Long.parseLong(idstr);

}

Form

@ApiImplicitParams({ @ApiImplicitParam(paramType = "form", dataType = "Long", name = "id", value = "信息id", required = true) })
@RequestMapping(value = "/findById5", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_UTF8_VALUE, consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE)

相关文章