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

項目簡介

該項目主要利用Spring Boot的自動化配置特性來實現快速的將swagger2引入spring boot應用來生成API文檔，簡化原生使用swagger2的整合代碼。

GitHub：https://github.com/dyc87112/s...
碼雲：http://git.oschina.net/didisp...
博客：http://blog.didispace.com

小工具一枚，歡迎使用和Star支持，如使用過程當中碰到問題，能夠提出Issue，我會盡力完善該Starter

版本基礎

• 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.1.0.RELEASE</version>
</dependency>

• 在應用主類中增長@EnableSwagger2Doc註解

@EnableSwagger2Doc
@SpringBootApplication
public 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.x
swagger.version=1.1.0.RELEASE
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=程序猿DD
swagger.contact.url=http://blog.didispace.com
swagger.contact.email=dyc87112@qq.com
swagger.base-package=com.didispace
swagger.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=/ops

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

上面的設置將解析全部除了/ops/開始以及spring boot自帶/error請求路徑。

其中，exclude-path能夠配合management.context-path=/ops設置的spring boot actuator的context-path來排除全部監控端點。