SpringBoot项目中使用Swagger2及注解解释（详细）
SpringBoot项目中使用Swagger2及注解解释
这里写目录标题
- SpringBoot项目中使用Swagger2及注解解释
- 一、导入Swagger坐标依赖
- 二、在spring启动类添加注解@EnableSwagger2
- 三、启动项目，查看swaggerui.html界面
- 四，编写SwaggerConfig配置文件
- 五：Swagger支持自定义注解
- 六：Swagger2常用注解
- @Api(常用)
- @ApiOperation
- @ApiParm
- @ApiIgnore
- @ApiImplicitParam(常用)
- @ApiImplicitParams
- @ApiModel(常用)
- @ApiModelProperty(常用)
一、导入Swagger坐标依赖
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>${swagger.version}</version>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>${swagger.version}</version>
</dependency>
其中版本最常用2.9.2
二、在spring启动类添加注解@EnableSwagger2
@EnableSwagger2是springfox提供的一个注解，代表swagger2相关技术开启。会扫描当前类所在包，及子包中所有类型的swagger相关注解，做swagger文档的定制
三、启动项目，查看swaggerui.html界面
这是我开发项目的地址，访问后可以看到swaggerui.html
http://localhost:9527/swagger-ui.html
点击try it out可以输入对应的参数查看返回结果
四，编写SwaggerConfig配置文件
@EnableSwagger2
@Configuration
public class SwaggerConfig {@Autowiredprivate ApplicationContext applicationContext;private Contact contact = new Contact("NIUA","localhost:8080/swagger-ui.html", "1053288979@qq.com");@Beanpublic Docket createRestApi() {ServletContext servletContext = applicationContext.getBean(ServletContext.class);return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.any()).paths(Predicates.not(regex("/error.*"))).build().apiInfo(apiInfo());}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("平台接口 v1.0").description("平台接口").contact(contact).version("1.0").build();}
}@Beanpublic Docket createRestApi() {ServletContext servletContext = applicationContext.getBean(ServletContext.class);return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.any()).paths(Predicates.not(regex("/error.*"))).build().apiInfo(apiInfo());}
创建Docker类型的对象，并使用spring容器管理。Docker是Swagger中的全局配置对象
DocumentationType.SWAGGER_2：给Docket一个类对象，知道是那一个版本的
apiInfo()：API文档的描述信息，参数是一个ApiInfo类对象，使用bulid()构建器来创建
private ApiInfo apiInfo() {return new ApiInfoBuilder().title("平台接口 v1.0").description("平台接口").contact(contact).version("1.0").build();}contact()：配置swagger文档的主体内容，里面填写也是一个类对象，类对象最多可以三个参数，发布者名称，文档发布者的网站url地址（企业网站），文档发布者的电子邮箱地址
private Contact contact = new Contact("NIUA","localhost:8080/swagger-ui.html", "1053288979@qq.com");title()：标题 description()：描述信息 .version()：版本信息
对应如下内容
select()：获取Docker中的选择器，返回ApiSelectorBuilder。构建选择器。如扫描什么包的注解
apis()：后面是RequestHandlerSelectors的类下的(Predicate)规则，规定扫描那些包的注解，默认是启动类及其子包下的注解
RequestHandlerSelectors类下有几个静态方法（举例三个）
basePackage()：后面填写包名的具体地址，会扫描改包及其子包的注解
docker.apis(RequestHandlerSelectors.basePackage("com.xxx"))any()：为任何接口生成API文档
none()：任何接口都不生成接口文档
path()：使用正则表达式，约束生成Api文档的路径地址，后面填写过滤（通过）的路径
//过滤掉admin路径下的所有页面 .paths(Predicates.not(PathSelectors.regex("/admin/.*"))) //过滤掉所有error或error.*页面 .paths(Predicates.not(PathSelectors.regex("/error.*")))//所有error或error.*页面或者admin路径下的所有页面都支持（or任意满足起一就通过） .paths(Predicates.or(PathSelectors.regex("/error.*"),PathSelectors.regex("/admin/.*")))
五：Swagger支持自定义注解
这里没有提及，感兴趣可以自己搜索（留个位置，日后用到了补充）
六：Swagger2常用注解
@Api(常用)
作用：@Api是类上注解。控制整个类生成接口信息的内容
属性：
tags：类的名称。可以有多个值，多个值表示多个副本（别名），有几个别名在swaggerui视图上显示几个控制器访问菜单
description：描述，已过时
@ApiOperation
作用：@ApiOperation是方法上注解，描述方法的相关消息
属性：
value：方法描述作用
notes：方法笔记（展开描述）
@ApiParm
作用：@ApiParm是方法参数的注解。描述该参数
属性：
name：参数名称
value：描述参数作用
required：值为boolean类型，表示该参数是否为必要参数，默认为false
@ApiIgnore
作用：@ApiParm是方法或者参数的注解。忽略注解的方法或者参数，不生成帮助文档
@ApiImplicitParam(常用)
作用：@ApiParm是作用于类上方法，用来描述方法参数的注解。
属性：
name：参数名称，和方法的参数一致
value：参数具体描述
required：值为boolean类型，表示该参数是否为必要参数，默认为false
paramType：参数类型
paramType="字符串" paramType = "header"dataType：数据类型
dataType = "string" //字符串数据 dataType = "键值对"
@ApiImplicitParams
后面跟@ApiImplicitParam的集合，一般用于多个参数的描述
@ApiImplicitParams({@ApiImplicitParam(name = "Authorization", value = "Authorization token", required = true, dataType = "string", paramType = "header")})
@ApiModel(常用)
作用：@ApiModel是作用于实体类上，描述一个实体类型，整个实体类型如果成为任何一个生成api帮助文档的返回对象的时候，该注解被解析
属性：
value：实体类名称
description：实体类描述
@ApiModelProperty(常用)
作用：@ApiModel是作用于实体类的属性上，描述实体类属性
属性：
value：实体属性描述
name：实体类属性名字，与属性名一致
SpringBoot项目中使用Swagger2及注解解释（详细）相关推荐
- springboot项目中利用@WebFilter注解和@Bean配置类两种方式实现Filter过滤器
过滤器(Filter) 过滤器实际上就是对web资源进行拦截,做一些处理后再交给下一个过滤器或servlet处理.通常都是用来拦截request进行处理的,也可以对返回的response进行拦截处理 ...
- springboot项目中使用shiro 自定义过滤器和token的方式___shiro使用token登录流程
springboot项目中使用shiro 自定义过滤器和token的方式 实现步骤主要是以下几步: 1. 在项目中导入maven依赖 <dependency><groupId> ...
- springboot项目中mybatis实现数据的基本查询
SpringBoot项目中mybatis实现数据的基本查询 本章内容概述: mapper 查询 xml 文件基本使用 通过 mybatis 实现一条数据的查询 1 用户数据表 2 用户信息对应的实体类 ...
- SpringBoot项目中遇到的BUG
1.启动项目的时候报错 1.Error starting ApplicationContext. To display the auto-configuration report re-run you ...
- 关于webservice服务在springboot项目中的开发的介绍
在springboot项目中搭建webservice服务端及使用客户端进行请求的介绍 一.引包 二.搭建webservice服务 (一)使用CXF搭建webservice服务 (二)webservic ...
- SpringBoot项目中ModelMapper配置以及使用
项目中对象与对象赋值转换使用的频率非常的高,比如数据库表实体对象(Entity)与业务类对象(Model)之间的赋值传递,或者模型对象(Model)与视图对象(ViewModel)之间的赋值传递.如果 ...
- 在SpringBoot项目中使用Ureport2报表工具
SpringBoot项目中使用Ureport2报表工具 1.在spring boot项目中使用Ureport2报表工具,首先需要在maven的pom.xml中添加Ureport2的依赖. <!- ...
- （RabbitMQ 二）Springboot项目中使用RabbitMQ的相关依赖
(RabbitMQ 二)Springboot项目中使用RabbitMQ的相关依赖 RabbitMQ系列文章如下: (RabbitMQ 一[转载])windows10环境下的RabbitMQ安装步骤 h ...
- SpringBoot12 QueryDSL01之QueryDSL介绍、springBoot项目中集成QueryDSL、利用QueryDSL实现单表RUD、新增类初始化逻辑...
1 QueryDSL介绍 1.1 背景 QueryDSL的诞生解决了HQL查询类型安全方面的缺陷:HQL查询的扩展需要用字符串拼接的方式进行,这往往会导致代码的阅读困难:通过字符串对域类型和属性的不安 ...
最新文章
- 软考下午题详解---uml图
- BCH社区公益广告位计划
- 《敏捷开发绩效管理》扩展阅读（敏捷开发绩效管理，敏捷团队绩效管理）
- KB929828：在Vista中使用Sysprep /generalize时出错
- nginx模块_使用gdb调试nginx源码
- 将Eclipse中的工程保存到Github的操作步骤
- 设计模式---享元模式（C++实现）
- matlab读取写入图像数据格式uint8,double
- 【STM32F103C8T6】 TTL转usb下载程序
- 嵌入式硬件入门——EEPROM（AT24C02+I2C协议）
- 汽车电子电气架构工程师的工作
- 5步操作，解决SOLIDWORKS处理复杂零件时卡顿的问题
- 实用工具软件远古大神Nir Sofer，数百款短小精悍便携工具，从Win2000到Win10通吃
- 49次全国计算机以及靠,第49次全国计算机等级考试（国考）证书领取的通知
- Java调用阿里云对象存储OSS
- 银行面试之MySQL数据库
- 真人qq秀代码_关于QQ我的记忆
- 喝王老吉可延长寿命大约10%?
- 【CF613D】Kingdom and its Cities（虚树，动态规划）
- 《JavaScript交互式网页设计》复习考试