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阅读 158,425评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,058评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,186评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,848评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,249评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,554评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,830评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,536评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,239评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,505评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,004评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,346评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,999评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,060评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,821评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,574评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,480评论 2 267

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,099评论 18 139
  • 1、准备 在分析探索Dubbo架构原理之前,我们需要准备一下环境,用于后面我们来分析dubbo的架构。 1.1 Z...
    墨渊丶阅读 2,549评论 1 20
  • 《回响的灵魂》八木重吉有意的戛然作响秋把夕阳铺开的时候魂魄穿过街一个劲儿跑“向西、向西”它这样回响着 而去 文/R...
    赵一初阅读 1,913评论 6 13
  • 今天刚回到家里,感触很多,深感责任重大。想做出点改变,就从早睡早起开始吧,这个假期十点睡。今天梁医生给我复诊,说我...
    苍白边缘阅读 104评论 0 0
  • 勇往直前, 做人生的大女主! 原创作者:阿布 4岁的时候看着被雪包围的村庄和灰蒙蒙的天空我意识到,自己是孤独的不知...
    妥妥的大女主阅读 247评论 0 1