常用注解：
@Api()用于类；
表示标识这个类是swagger的资源 ，@Api 注解用于标注一个Controller（Class）
@ApiOperation()用于方法；
表示一个http请求的操作
@ApiParam()用于方法，参数，字段说明；
表示对参数的添加元数据（说明或是否必填等）
@ApiModel()用于类
表示对类进行说明，用于参数用实体类接收
@ApiModelProperty()用于方法，字段
表示对model属性的说明或者数据操作更改
@ApiIgnore()用于类，方法，方法参数
表示这个方法或者类被忽略
@ApiImplicitParam() 用于方法
表示单独的请求参数
@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam
@Api
@Api 注解用于标注一个Controller==（Class）。在默认情况下，Swagger-Core只会扫描解析具有@Api注解的类，而会自动忽略其他类别资源（JAX-RS endpoints，Servlets等等）的注解。
@Api属性一览表：
示例代码：
@[ApiOperation
@ApiOperation 注解在用于对一个操作或HTTP方法进行描述（用于@mapping方法上）==。具有相同路径的不同操作会被归组为同一个操作对象。不同的HTTP请求方法及路径组合构成一个唯一操作。
示例代码：
@ApiParam
@ApiParam作用于请求方法上，定义api参数的注解。
示例代码：
- name： 参数名
- value： 参数说明
- required：是否必填
@ApiImplicitParams、@ApiImplicitParam
@ApiImplicitParams、@ApiImplicitParam 都可以定义参数.
(1).@ApiImplicitParam() 用于方法
表示单独的请求参数
(2).@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam ，用在请求的方法上，包含一组参数说明；
- name–参数名字
- value–参数说明
- dataType–数据类型
- paramType–参数类型
- example–举例说明
代码示例：
@ApiResponses、@ApiResponse
@ApiResponses、@ApiResponse进行方法返回对象的说明。
代码示例：
@ApiModel、@ApiModelProperty
@ApiModel用于描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）。
@ApiModelProperty用来描述一个Model的属性
使用场景
- @ApiModel 用在模型类上,对模型类作注解
- @ApiModelProperty 用在属性上,对属性作注解
代码演示:
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请联系我们，一经查实，本站将立刻删除。
如需转载请保留出处：https://51itzy.com/kjqy/143427.html