简化Swagger使用的自制Starter：spring-boot-starter-swagger，欢迎使用和吐槽

项目简介

该项目主要利用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

小工具一枚，欢迎使用和Star支持，如使用过程中碰到问题，可以提出Issue，我会尽力完善该Starter

版本基础

• Spring Boot：1.5.x

• Swagger：2.7.x

如何使用

在该项目的帮助下，我们的Spring Boot可以轻松的引入swagger2，主需要做下面两个步骤：

• 在 pom.xml中引入依赖：

1. <dependency>

2.    <groupId>com.didispace</groupId>

3.    <artifactId>spring-boot-starter-swagger</artifactId>

4.    <version>1.1.0.RELEASE</version>

5. </dependency>

• 在应用主类中增加 @EnableSwagger2Doc注解

1. @EnableSwagger2Doc

2. @SpringBootApplication

3. public class Bootstrap {

4.    public static void main(String[] args) {

5.        SpringApplication.run(Bootstrap.class, args);

6.    }

7. }

默认情况下就能产生所有当前Spring MVC加载的请求映射文档。

参数配置

更细致的配置内容参考如下：

配置示例

1. swagger.title=spring-boot-starter-swagger

2. swagger.description=Starter for swagger 2.x

3. swagger.version=1.1.0.RELEASE

4. swagger.license=Apache License, Version 2.0

5. swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html

6. swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger

7. swagger.contact.name=程序猿DD

8. swagger.contact.url=http://blog.didispace.com

9. swagger.contact.email=[e-mail]

10. swagger.base-package=com.didispace

11. swagger.base-path=/**

12. 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来剔除部分我们不需要的。

比如，通常我们可以这样设置：

1. management.context-path=/ops

2. swagger.base-path=/**

3. swagger.exclude-path=/ops/**, /error

上面的设置将解析所有除了 /ops/开始以及spring boot自带 /error请求路径。

其中， exclude-path可以配合 management.context-path=/ops设置的spring boot actuator的context-path来排除所有监控端点。

相关阅读

长按指纹

一键关注

好书推荐            

点击“阅读原文”