Swagger常用注解实验

(Updated: )
开发实践

@Api() 用于类 表明此类为swagger资源

  • value url的路径值
  • tags 如果设置这个值、value的值会被覆盖

image-20220128205957209

image-20220128210038536

@ApiOperation() 用于方法 说明方法的作用，每个URL资源的定义、

  • value 方法描述
  • notes 提示内容
  • tags 可重新分组（选用）

image-20220128210855336

image-20220128211012902

@ApiParam() 用于方法、参数、字段说明

  • name 参数名称
  • value 参数说明
  • required 是否必填
  • example 样例说明

image-20220128213555248

image-20220128213626946

@ApiModel() 用于Post中表单的实体类

  • value 对象名
  • description 描述

常用于使用通过@RequestBody来提交表单的场景

image-20220128214752333

image-20220128215042476

@ApiModelProperty() 用于方法 、字段 对实体类属性进行说明

  • value 字段说明
  • name 字段名字
  • dataType 重写属性类型（非必须不用加）
  • required 是否必填
  • example 样例
  • hidden 隐藏

image-20220128224718872

image-20220128224939283

通过该注解，在提交Body数据时，会提供详细的关于字段的解释以及正确的样例

@ApiImplicitParam() @ApiImplicitParams()

功能和@ApiParam(),一般情况下使用@ApiParam即可