SpringBoot swagger-dubbo 整合

加入 maven 依賴,這里使用的 springfox.version 版本是 2.7.0 (2.9.2 有問題)swagger.version 版本是 1.5.20需要手動引入 swagger 相關依賴,避免引入 1.5.13 造成沖突),
swagger-dubbo 版本是 2.0.1


    <springfox.version>2.7.0</springfox.version>
    <swagger.version>1.5.20</swagger.version>
    <spring.dubbo.version>2.0.1</spring.dubbo.version>
<!-- Swagger Core -->
      <dependency>
        <groupId>io.swagger</groupId>
        <artifactId>swagger-core</artifactId>
        <version>${swagger.version}</version>
      </dependency>

      <dependency>
        <groupId>io.swagger</groupId>
        <artifactId>swagger-annotations</artifactId>
        <version>${swagger.version}</version>
      </dependency>

      <dependency>
        <groupId>io.swagger</groupId>
        <artifactId>swagger-models</artifactId>
        <version>${swagger.version}</version>
      </dependency>
<!-- swagger ui -->
      <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>${springfox.version}</version>
        <exclusions>
          <exclusion>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
          </exclusion>
        </exclusions>
      </dependency>
      <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>${springfox.version}</version>
      </dependency>

      <dependency>
        <groupId>org.webjars</groupId>
        <artifactId>swagger-ui</artifactId>
        <version>3.17.6</version>
      </dependency>

      <dependency>
        <groupId>com.deepoove</groupId>
        <artifactId>swagger-dubbo</artifactId>
        <version>${spring.dubbo.version}</version>
      </dependency>

SwaggerDubboConfiguration 上加入注解 @EnableDubboSwagger
通過 PropertySource 配合 Configuration 一起使用將 swagger-dubbo.properties 屬性變量注入到 Spring's Environment

JavaConfig 配置如下:

/**
 * @Author: zyn
 * @Description: PropertySource 配合 Configuration一起使用將屬性注入到 Spring's Environment
 *                這里不重寫 addResourceHandler 方法的原因是,在 SwaggerConfiguration 中已經
 *                將 classpath:/META-INF/resources/ 添加到了靜態資源目錄,當訪問 swagger-dubbo-ui.html 時
 *                默認去 classpath:/META-INF/resources/ 目錄下查找對應的 html
 * @Date: Created in 2018-10-31 11:11
 * @Modified By:
 */
@Configuration
@EnableDubboSwagger
@PropertySource(value = "classpath:env/swagger-dubbo.properties", ignoreResourceNotFound = true, encoding = "UTF-8")
public class SwaggerDubboConfiguration extends WebMvcConfigurerAdapter {

//  @Override
//  public void addResourceHandlers(ResourceHandlerRegistry registry) {
//    registry.addResourceHandler("swagger-dubbo-ui.html")
//        .addResourceLocations("classpath:/META-INF/resources/");
//  }
  
}

swagger-dubbo.properties 配置如下

#http請求地址,默認為http://ip:port/h/com.XXX.XxService/method
swagger.dubbo.http=dubbo

#dubbo 服務版本號
swagger.dubbo.application.version = v1.0.0
#dubbo服務groupId
swagger.dubbo.application.groupId = com.xxx
#dubbo服務artifactId
swagger.dubbo.application.artifactId = back-trade-dubbo-provider

#rpc zk調用 or 本地調用
swagger.dubbo.cluster = rpc

#是否啟用swagger-dubbo,默認為true,如果是生產環境就設置為false
swagger.dubbo.enable = true

resources 下 新建如下目錄,并加入靜態資源

image.png
  1. swagger-ui.html 從如下目錄拷貝

    image.png

  2. swagger-dubbo-ui.htmlhttps://github.com/swagger-api/swagger-ui/blob/master/dist/index.html 拷貝,并修改資源引入路徑(修改為 webjar 引入)

  3. 修改 SwaggerConfiguration 配置文件,繼承 WebMvcConfigurerAdapter,添加資源處理器和靜態資源位置

@Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/webjars/**")
        .addResourceLocations("classpath:/META-INF/resources/webjars/");

    registry.addResourceHandler("swagger-ui.html")
        .addResourceLocations("classpath:/META-INF/resources/");
  }

訪問 http://localhost:9091/swagger-dubbo-ui.html,結果如下圖

image.png

參考文章

  1. https://blog.csdn.net/xichenguan/article/details/52794862
  2. https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching?hl=zh-cn#cache-control
  3. https://qiita.com/kazuki43zoo/items/e12a72d4ac4de418ee37

總結:

  1. 集成 swagger-dubbo 的時候發現 @ApiModel 標記的實體在 swagger-dubbo-ui.html 頁面上不顯示的問題,debug 跟蹤源碼發現,只有接口方法返回單個對象的時候,才能掃描到,例如 List<TradeDto> test(); 不顯示, 而TradeDto test(); 顯示
  2. 由于 dubbo 服務中設置了分組,導致不能進行接口測試,所有設置都不進行分組的話,則可以進行接口測試(同事大神告訴我的,暫時還沒有進行測試)
  3. swagger-dubbo 查詢接口,實體信息的接口地址是 /swagger-dubbo/api-docs而不是 /swagger-dubbo/swagger.json
    image.png
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,321評論 6 543
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,559評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,442評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,835評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,581評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,922評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,931評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,096評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,639評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,374評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,591評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,104評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,789評論 3 349
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,196評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,524評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,322評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,554評論 2 379

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,826評論 18 139
  • 1、準備 在分析探索Dubbo架構原理之前,我們需要準備一下環境,用于后面我們來分析dubbo的架構。 1.1 Z...
    墨淵丶閱讀 2,615評論 1 20
  • 《回響的靈魂》八木重吉有意的戛然作響秋把夕陽鋪開的時候魂魄穿過街一個勁兒跑“向西、向西”它這樣回響著 而去 文/R...
    趙一初閱讀 2,043評論 6 13
  • 今天剛回到家里,感觸很多,深感責任重大。想做出點改變,就從早睡早起開始吧,這個假期十點睡。今天梁醫生給我復診,說我...
    蒼白邊緣閱讀 182評論 0 0
  • 勇往直前, 做人生的大女主! 原創作者:阿布 4歲的時候看著被雪包圍的村莊和灰蒙蒙的天空我意識到,自己是孤獨的不知...
    妥妥的大女主閱讀 356評論 0 1