swagger

注解

  • @Api:用在类上,说明该类的做用。
  • @ApiOperation:注解来给API增长方法说明。
  • @ApiImplicitParams : 用在方法上包含一组参数说明。
  • @ApiImplicitParam:用来注解来给方法入参增长说明。
  • @ApiResponses:用于表示一组响应
  • @ApiResponse:用在@ApiResponses中,通常用于表达一个错误的响应信息
    code:数字,例如400
    message:信息,例如"请求参数没填好"
    response:抛出异常的类
  • @ApiModel:描述一个Model的信息(通常用在请求参数没法使用@ApiImplicitParam注解进行描述的时候)
    @ApiModelProperty:描述一个model的属性

问题:

返回json不能写注释,请求是json的话也不行,最后API文档仍是用markdown来写了json

相关文章
相关标签/搜索