1、背景

前面有介绍过swagger的项目集成步骤，但是没有确切的注解使用内容。https://blog.csdn.net/miwanmeng/article/details/89516176

下面我就对swagger使用注解进行一些比较细化的记录，如果漏了啥，可以在提醒我。下面直接进入主题。

2、内容

@Api

说明：用于controller层类注解，参数有value和tags。都是说明的意思。（注解写在类上）

@ApiOperation(value = "新增")

说明：用于controller层方法注解，value用于方法描述，notes用于提示内容，tags可以分组说明。都是说明的意思。（注解写在方法上）

@ApiParam()

说明：用于controller层方法参数注解，name-参数名，value用于参数说明，required参数是否必填。（注解写在方法上）

@ApiModel

说明：用于实体类vo注解，value用于类说明，直接填写类名，description用于表示Model描述说明。（注解写在类上）

@ApiModelProperty

说明：用于实体类vo参数注解，value用于参数字段说明，name填写属性名字一般直接写变量名，dataType用于填写参数类型，required是否必须填写，example举例一般不用，hidden在swagger中隐藏。（注解写在参数上）

@ApiIgnore()

说明：用于类或者方法上，在swagger中隐藏。（注解写在类或者方法上）

@ApiImplicitParam()

说明：用于controller层类注解方法参数注解。name-参数名，value用于参数说明，dataType用于填写参数类型，required是否必须填写，example举例一般不用。改注解和@ApiParam类似所以可以二选一使用（注解写在方法的括号里）

@ApiImplicitParams()

说明：用于controller层类注解方法参数注解，其实就是多个@ApiImplicitParam()（注解写在方法的括号里）

2、总结

其实对于swagger还是比较简单的，以上就是我常用的注解，不过应该每个注解还有很多其他的参数，这上面只是我用的时候经常用到的一些。

swagger注解的使用相关推荐

java 生成并覆盖文件,基于mybatis-plus生成不被覆盖的文件并支持swagger注解
情况是这样的: 原本mybatis-plus的框架的模板是不支持swagger的注解的,需要手动写. 自己折腾了1个多小时,建立在mybatis-plus的基础上进行修改.可以选择生成文件时,不覆盖某 ...
保存系统的操作日志，通过swagger注解获取请求描述（通用版本）
版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明. 大数据系列文章目录前言系统之前没有全局的记录操作日志,只是个别单个功能记录了操作日志,这样 ...
什么是swagger以及swagger注解详解
1.什么是swagger Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言 ...
【SpringBoot】mybatis 自动生成swagger注解，及普通查询sql
1.项目结构 1.pom文件中的引入 <?xml version="1.0" encoding="UTF-8"?> <project xmln ...
【swagger】Swagger注解介绍
Swagger注解介绍 1.swagger注解 @ApiModel: 用于类,表示对类进行说明,用于参数用实体类接收 @ApiProperty:用于字段,表示对model属性的说明或者数据操作更改 @ ...
swagger注解说明_swagger2常用注解说明
原文:https://blog.csdn.net/u014231523/article/details/76522486 说明: 1.这里使用的版本:springfox-swagger2(2.4)sp ...
Swagger 注解使用
一.实体类配置 1.新建一个实体类 @ApiModel("用户实体") public class User {@ApiModelProperty("姓名")pu ...
Swagger注解详解
目录 1. @Api 2. @APiOperation 3. @ApiImplicitParams 4. @ApiResponses 5. @ApiModel 6. @ApiModelProperty ...
spring aop 自定义注解配合swagger注解保存操作日志到mysql数据库含（源码）
spring aop 自定义注解保存操作日志到mysql数据库一.思路二.自定义注解三.编写操作日志四.编写操作日志切面\增强五.使用六.`注意` 一.思路利用spring aop 对方 ...
Swagger 注解~其他
@ApiIgnore 用于类或者方法上,可以不被swagger显示在页面上比较简单, 这里不做举例 @ApiImplicitParam 用于方法,表示单独的请求参数 @ApiImplicitPar ...

swagger注解的使用

1、背景

2、内容

swagger注解的使用相关推荐

最新文章

热门文章