swagger文档使用常用注解

简介: swagger文档使用常用注解

常用注解

Swagger的所有注解定义在io.swagger.annotations包下,常用注解如下:

注解

说明

用于controller类上

@Api(tags = “xxx模块说明”)

作用在类上

tags="说明该类的作用"

value="该参数没什么意义,所以不需要配置"

用于方法上面(说明参数的含义)

@ApiOperation(“xxx接口说明”)

作用在接口方法上

value用于方法描述

notes用于提示内容,接口描述

tags可以重新分组(视情况而用,一般不建议使用)

@ApiImplicitParam()

@ApiImplicitParams() 

用于方法,包含多个 @ApiImplicitParam

用于方法上面(返回参数或对象的说明)

@ApiResponse

用于指定单个参数的说明

方法返回值的说明 

code:数字,例如400

message:信息,例如"请求参数没填好"

response:响应参数描述类

注明:如果使用的3.0版本,

需要增加配置:

springfox.documentation.swagger.use-model-v3=false

@ApiResponses

包含多个@ApiResponse

对象类

@ApiModel(“xxxPOJO说明”)

作用在模型类上:如VO、BO

value–表示对象名

description–描述都可省略

@ApiModelProperty(value = “xxx属性说明”,hidden = true)

作用在类方法和属性上

value–字段说明

name–重写属性名字

dataType–重写属性类型

required–是否必填

example–举例说明

hidden–隐藏

@ApiParam(“xxx参数说明”)

用于方法,参数,字段说明,表示对参数的添加元数据(说明或是否必填等)

name–参数名

value–参数说明

required–是否必填

其它

@ApiIgnore()

用于类,方法,方法参数,表示这个方法或者类被忽略

目录
相关文章
|
1月前
|
数据可视化 Linux API
如何在Linux使用docker部署Swagger Editor并实现无公网IP远程协同编辑API文档
如何在Linux使用docker部署Swagger Editor并实现无公网IP远程协同编辑API文档
|
2月前
|
Java API
Swagger 常用注解使用详解
Swagger 常用注解使用详解
28 2
|
3月前
|
数据可视化 Linux API
使用Docker安装部署Swagger Editor并远程访问编辑API文档
使用Docker安装部署Swagger Editor并远程访问编辑API文档
49 0
|
4月前
|
Dubbo Java 测试技术
提升API文档品质:Swagger annotations (注解)使用教程
Swagger 提供的注解集是其框架中定义 API 规范和文档的重要工具。这些注解在代码里标注重要部分,为 Swagger 的解析工作铺路,进而生成详尽的 API 文档。开发者编写的注释能够被转换成直观的文档,并展现API端点、参数和响应等信息。这不仅提升了开发人员对 API 运作的理解与沟通,也使得测试和集成过程更加顺畅。
|
4月前
|
搜索推荐
Swagger中的一些常用注解(下)
Swagger中的一些常用注解(下)
26 0
|
4月前
|
API
Swagger中的一些常用注解(上)
Swagger中的一些常用注解(上)
22 0
|
4月前
|
JSON 前端开发 Java
历经14天自定义3个注解解决项目的3个Swagger难题
历经14天自定义3个注解解决项目的3个Swagger难题
84 0
|
6月前
|
API Python
flask 生成swagger文档
flask 生成swagger文档
81 0
|
6月前
使用Swagger 让某些接口不显示在文档
使用Swagger 让某些接口不显示在文档
36 0
|
6月前
|
API
swagger2 注解说明 @ApiImplicitParam和@ApiImplicitParams的用法
swagger2 注解说明 @ApiImplicitParam和@ApiImplicitParams的用法
37 0