swagger簡介：

swagger是一款開源的api接口文檔生成工具。

Swagger的項目主頁：https://swagger.io/? ? 目前比較流行的做法是在代碼中加入swagger相關的注釋，然后，利用小工具生成swagger.json或者swagger.yaml文件。

springboot將swagger變得更加簡單：

springboot擁有自己的自動配置特性，而swagger也發布了應用于springboot的自動依賴配置模塊。

也就是說，只需要在pom文件中引入swagger模塊配置信息，然后在application中進行swagger框架的簡單配置，即可輕松通過瀏覽器訪問由swagger為我們生成的網頁版接口說明文檔。

具體步驟：

1.首先我們需要在pom.xml中加入swagger模塊配置信息，將swagger模塊引入到項目中：

????????<!-- https://mvnrepository.com/artifact/com.spring4all/spring-boot-starter-swagger --><dependency><groupId>com.spring4all</groupId><artifactId>spring-boot-starter-swagger</artifactId><version>1.5.1.RELEASE</version></dependency>

2.在springboot啟動類中加入注解：

@EnableSwagger2Doc @SpringBootApplication public class Bootstrap {public static void main(String[] args) {SpringApplication.run(Bootstrap.class, args);} }

3.加入swagger配置信息：

在網上看到有兩種配置方式，一種是另起一個application.yaml，然后通過yaml語言進行配置，另一種方式是在已有的application.properties中加入配置（這里記載第二種方式）：

#swagger配置信息 swagger.title=yyh project online API specification swagger.description=the web page which you opened is generated by swagger automatically swagger.version=1.5.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=mht swagger.contact.url=http://localhost:8080/swagger-ui.html swagger.contact.email=haotian.mou@ahav.com.cn swagger.base-package=com.seco swagger.base-path=/** #配置說明： 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規則，默認：空

4.API文檔效果查看：

啟動項目，打開瀏覽器在地址欄輸入如下地址即可查看生成的API文檔：

http://localhost:8080/swagger-ui.html

參考文章：

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

《使用spring-boot-starter-swagger實現API文檔化》

《5分鐘了解swagger》

==============================2018-8-8 ，星期三，下午，更新? ============================== ?

Spring Boot+shiro攔截swagger路徑問題解決

在shiro攔截器配置方法中，加入對swagger的開發路徑即可，如下代碼所示

/*** 配置shiro攔截器，用于url，粗粒度攔截* <br>作者： mht<br> * 時間：2018年8月3日-上午10:29:07<br>* @return*/@Beanpublic ShiroFilterChainDefinition chain() {DefaultShiroFilterChainDefinition chain = new DefaultShiroFilterChainDefinition();chain.addPathDefinition("/users/login", "anon");// 除了以上url剩下的都需要登錄 TODO:攔截后的跳轉功能//swagger接口權限 開放4個路徑chain.addPathDefinition("/swagger-ui.html", "anon");chain.addPathDefinition("/webjars/**", "anon");chain.addPathDefinition("/v2/**", "anon");chain.addPathDefinition("/swagger-resources/**", "anon");chain.addPathDefinition("/**", "authc");return chain;}

注：其中，/webjars/** ?和?/v2/** ?也是swagger 的相關資源路徑，需要一同開放。

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

以上是生活随笔為你收集整理的Swagger自动接口文档生成框架————springboot整合swagger总结的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。