SpringBoot-Swagger整合zuul智慧列表

簡介

可能大家都有用過swagger,可以通過ui頁面顯示介面資訊，快速和前端進行聯調。

現在基本都是多模組微服務化，每個服務都有這樣的ui頁面也是很不方便，swagger 也可以聚合在閘道器頁面。

有開發過微服務的小夥伴應該體驗過。當微服務模組多的情況下，每個模組都需要配置這樣的一個類進行載入 swagger 。造成每個模組都存在大致一樣的 SwaggerConfig ,極端的情況下，有些朋友複製其他模組的 SwaggerConfig 進行改造之後，發現仍然載入不出 swagger 的情況，造成明明是複製的，為何還載入不出，排查此bug極其費時間。

在此之上，可以構建出一個 swagger-starter 模組，只需要引用一個 jar ，載入一些特殊的配置，就可以快速地使用到 swagger 的部分功能了。

功能使用

新增依賴

ps: 實際version版本請使用最新版
最新版本:

點選檢視最新新版本

<dependency>
  <groupId>com.purgeteam</groupId>
  <artifactId>swagger-spring-boot-starter<factId>
  <version>0.1.2.RELEASE</version>
</dependency>
 

配置swagger.properties檔案

在自己專案模組的resources目錄下 建立swagger.properties配置

swagger.basePackage="swagger掃描專案包路徑"
swagger.title="swagger網頁顯示標題"
swagger.description="swagger網頁顯示介紹"

@EnableSwaggerPlugins註解。

@EnableSwaggerPlugins
@SpringBootApplication
public class FrontDemoApplication {

  public static void main(String[] args) {
    SpringApplication.run(FrontDemoApplication.class, args);
  }

}
 

訪問http://ip:埠/swagger-ui.html檢查swagger-ui是否正常。

Zuul閘道器整合

做完上面步驟一個單體服務已經完成了 swagger 的配置。

整合到 zuul 閘道器上還需要配置其他的整合配置。

不過使用 swagger-spring-boot-starter 之後，流程變得很輕鬆。

只需要新增下面 @EnableSwaggerZuul 註解即可完成整合動作。

@EnableSwaggerZuul
@SpringBootApplication
public class ZuulApplication {

  public static void main(String[] args) {
    SpringApplication.run(ZuulApplication.class, args);
  }

}

訪問http://ip:埠/swagger-ui.html檢查swagger-ui是否正常。

狀態支援

在 Select a spec 選擇框裡可以選擇閘道器下的微服務列表進行聚合展示。

這裡也支援了服務狀態顯示。

health > "使用者服務"(user)
health > "認證服務"(auth)
sick > front-demo(已下線)
sick > giant-demo(已下線)

這裡的 使用者服務 認證服務 名稱是根據相應服務的 swagger.properties 檔案屬性名 swagger.title 獲取。

總結

簡單的starter程式碼編寫可以減少新模組的複雜性，只需要簡單的配置就可以使用相應的特性，減少複製程式碼不必要的錯誤。

示例程式碼地址:swagger-spring-boot

作者GitHub:
Purgeyao 歡迎關注

qq交流群: 812321371 微信交流群: MercyYao

微信公眾號:

相關推薦