Swagger常用注解

Swagger常用注解

实体类上

@ApiModel：在实体类上边使用，标记类时swagger的解析类

• value：表示对象名

• description：描述

@ApiModelProperty：用于方法，字段； 表示对model属性的说明或者数据操作更改

• value：字段说明
• name：重写属性名字
• dataType：重写属性类型
• required：是否必填
• example：举例说明
• hidden：隐藏

控制器上

@Api：标注在资源类上，Spring框架中一般使用在控制层

• value：和tags相似，如果存在tags，则该值会被忽略，一般使用tags

• tags：说明，该说明会展示在swagger页面中

@ApiOperation：用于修饰Controller类中的方法，生成接口方法相关文档信息

• value：对应操作的“摘要”字段，会展示是swagger-UI中
• tags：重新分组
• notes：操作的详细描述，也会展示是swagger-UI中

@ApiParam：用于修饰接口中的参数，生成接口参数相关文档信息

• name：参数名
• value：参数说明
• required：是否必填