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()

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

目录
相关文章
|
6月前
|
Oracle 关系型数据库 Java
程序员必备推荐一款与Swagger媲美的数据库文档生成工具
程序员必备推荐一款与Swagger媲美的数据库文档生成工具
74 0
|
6月前
|
数据可视化 Linux API
如何在Linux使用docker部署Swagger Editor并实现无公网IP远程协同编辑API文档
如何在Linux使用docker部署Swagger Editor并实现无公网IP远程协同编辑API文档
|
6月前
|
Java API
Swagger 常用注解使用详解
Swagger 常用注解使用详解
102 2
|
6月前
|
数据可视化 Linux API
使用Docker安装部署Swagger Editor并远程访问编辑API文档
使用Docker安装部署Swagger Editor并远程访问编辑API文档
123 0
|
4月前
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
20天前
|
安全 Java API
SpringSecurity结合knife4j实现swagger文档
通过将Spring Security与Knife4j相结合,我们不仅能够为RESTful API提供强大的安全防护,还能保证API文档的易用性和可访问性,这对于API的设计、开发和维护来说至关重要。这种集成方式不仅提升了开发效率,也优化了API使用者的体验,是现代API驱动开发中不可或缺的一环。
55 0
|
2月前
|
API
Swagger2 常用注解介绍
Swagger2 常用注解介绍
|
3月前
|
JSON 测试技术 API
Python开发解析Swagger文档小工具
文章介绍了如何使用Python开发一个解析Swagger文档的小工具,该工具可以生成符合httprunner测试框架的json/yaml测试用例,同时还能输出Excel文件,以方便测试人员根据不同需求使用。文章提供了详细的开发步骤、环境配置和使用示例,并鼓励读者为该开源项目贡献代码和建议。
66 1
Python开发解析Swagger文档小工具
|
4月前
|
安全 Java API
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
这篇文章介绍了Swagger,它是一组开源工具,围绕OpenAPI规范帮助设计、构建、记录和使用RESTAPI。文章主要讨论了Swagger的主要工具,包括SwaggerEditor、SwaggerUI、SwaggerCodegen等。然后介绍了如何在Nest框架中集成Swagger,展示了安装依赖、定义DTO和控制器等步骤,以及如何使用Swagger装饰器。文章最后总结说,集成Swagger文档可以自动生成和维护API文档,规范API标准化和一致性,但会增加开发者工作量,需要保持注释和装饰器的准确性。
122 0
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
|
4月前
|
JSON 数据格式
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解