spring-boot-starter-swagger 1.2.0.RELEASE:新增分组配置功能
时间:2022-05-05
本文章向大家介绍spring-boot-starter-swagger 1.2.0.RELEASE:新增分组配置功能,主要内容包括简介、版本基础、如何使用、参数配置、配置说明、基本概念、基础应用、原理机制和需要注意的事项等,并结合实例形式分析了其使用技巧,希望通过本文能帮助到大家理解应用这部分内容。
简介
该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档,简化原生使用swagger2的整合代码。
- GitHub:https://github.com/dyc87112/spring-boot-starter-swagger
- 码云:http://git.oschina.net/didispace/spring-boot-starter-swagger
- 博客:http://blog.didispace.com
版本基础
- Spring Boot:1.5.x
- Swagger:2.7.x
如何使用
在该项目的帮助下,我们的Spring Boot可以轻松的引入swagger2,主需要做下面两个步骤:
- 在
pom.xml
中引入依赖:
<dependency>
<groupId>com.didispace</groupId>
<artifactId>spring-boot-starter-swagger</artifactId>
<version>1.2.0.RELEASE</version>
</dependency>
- 在应用主类中增加
@EnableSwagger2Doc
注解
@EnableSwagger2Doc
@SpringBootApplicationpublic class Bootstrap {
public static void main(String[] args) {
SpringApplication.run(Bootstrap.class, args);
}
}
默认情况下就能产生所有当前Spring MVC加载的请求映射文档。
参数配置
更细致的配置内容参考如下:
配置示例
swagger.title=spring-boot-starter-swagger
swagger.description=Starter for swagger 2.xswagger.version=1.1.0.RELEASEswagger.license=Apache License, Version 2.0swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.htmlswagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swaggerswagger.contact.name=didiswagger.contact.url=http://blog.didispace.comswagger.contact.email=dyc87112@qq.comswagger.base-package=com.didispaceswagger.base-path=/**swagger.exclude-path=/error, /ops/**
配置说明
默认配置
- swagger.title=标题- swagger.description=描述- swagger.version=版本- swagger.license=许可证- swagger.licenseUrl=许可证URL- swagger.termsOfServiceUrl=服务条款URL- swagger.contact.name=维护人- swagger.contact.url=维护人URL- swagger.contact.email=维护人email- swagger.base-package=swagger扫描的基础包,默认:全扫描- swagger.base-path=需要处理的基础URL规则,默认:/**- swagger.exclude-path=需要排除的URL规则,默认:空
Path规则说明
swagger.base-path
和 swagger.exclude-path
使用ANT规则配置。
我们可以使用 swagger.base-path
来指定所有需要生成文档的请求路径基础规则,然后再利用 swagger.exclude-path
来剔除部分我们不需要的。
比如,通常我们可以这样设置:
management.context-path=/opsswagger.base-path=/**swagger.exclude-path=/ops/**, /error
上面的设置将解析所有除了 /ops/
开始以及spring boot自带 /error
请求路径。
其中, exclude-path
可以配合 management.context-path=/ops
设置的spring boot actuator的context-path来排除所有监控端点。
分组配置
当我们一个项目的API非常多的时候,我们希望对API文档实现分组。从1.2.0.RELEASE开始,将支持分组配置功能。
具体配置内容如下:
- swagger.docket.<name>.title=标题- swagger.docket.<name>.description=描述- swagger.docket.<name>.version=版本- swagger.docket.<name>.license=许可证- swagger.docket.<name>.licenseUrl=许可证URL- swagger.docket.<name>.termsOfServiceUrl=服务条款URL- swagger.docket.<name>.contact.name=维护人- swagger.docket.<name>.contact.url=维护人URL- swagger.docket.<name>.contact.email=维护人email- swagger.docket.<name>.base-package=swagger扫描的基础包,默认:全扫描- swagger.docket.<name>.base-path=需要处理的基础URL规则,默认:/**- swagger.docket.<name>.exclude-path=需要排除的URL规则,默认:空
说明: <name>
为swagger文档的分组名称,同一个项目中可以配置多个分组,用来划分不同的API文档。
分组配置示例
swagger.docket.aaa.title=group-aswagger.docket.aaa.description=Starter for swagger 2.xswagger.docket.aaa.version=1.2.0.RELEASEswagger.docket.aaa.termsOfServiceUrl=https://gitee.com/didispace/spring-boot-starter-swaggerswagger.docket.aaa.contact.name=zhaiyongchaoswagger.docket.aaa.contact.url=http://spring4all.com/swagger.docket.aaa.contact.email=didi@potatomato.clubswagger.docket.aaa.excludePath=/ops/**swagger.docket.bbb.title=group-bbbswagger.docket.bbb.basePackage=com.yonghui
说明:默认配置与分组配置可以一起使用。在分组配置中没有配置的内容将使用默认配置替代,所以默认配置可以作为分组配置公共部分属性的配置。
- java教程
- Java快速入门
- Java 开发环境配置
- Java基本语法
- Java 对象和类
- Java 基本数据类型
- Java 变量类型
- Java 修饰符
- Java 运算符
- Java 循环结构
- Java 分支结构
- Java Number类
- Java Character类
- Java String类
- Java StringBuffer和StringBuilder类
- Java 数组
- Java 日期时间
- Java 正则表达式
- Java 方法
- Java 流(Stream)、文件(File)和IO
- Java 异常处理
- Java 继承
- Java 重写(Override)与重载(Overload)
- Java 多态
- Java 抽象类
- Java 封装
- Java 接口
- Java 包(package)
- Java 数据结构
- Java 集合框架
- Java 泛型
- Java 序列化
- Java 网络编程
- Java 发送邮件
- Java 多线程编程
- Java Applet基础
- Java 文档注释
- Laravel 自动生成验证的实例讲解:login / logout
- 关于Laravel-admin的基础用法总结和自定义model详解
- 解决Laravel5.2 Auth认证退出失效的问题
- php输出文字乱码的解决方法
- laravel-admin表单提交隐藏一些数据,回调时获取数据的方法
- laravel 5.3 单用户登录简单实现方法
- Thinkphp5.0 框架的请求方式与响应方式分析
- Yii框架视图、视图布局、视图数据块操作示例
- 用php定义一个数组最简单的方法
- laravel-admin自动生成模块,及相关基础配置方法
- laravel-admin select框默认选中的方法
- Laravel-admin之修改操作日志的方法
- php使用curl伪造浏览器访问操作示例
- 关于laravel后台模板laravel-admin select框的使用详解
- 基于Laravel-admin 后台的自定义页面用法详解