使用knife4j實現(xiàn)分布式swagger文檔聚合

在項目開發(fā)過程中,接口文檔的使用是在所難免的,但是在微服務(wù)場景下,多個服務(wù)之間的swagger是分散的,雖然swagger提供了微服務(wù)的聚合方式,配置過于繁瑣,加之swagger本身的功能比較少,而且ui布局也比較蛋痛,此處推薦一款新框架用于增強swagger以及實現(xiàn)微服務(wù)接口文檔的聚合

knife4j官方文檔:https://doc.xiaominfo.com/docs/

此處使用文檔中提供的Spring Cloud Gateway網(wǎng)關(guān)聚合 | Knife4j (xiaominfo.com)方式

依賴引入

在整個項目的父pom中

    <properties>
        <springdoc.version>2.0.2</springdoc.version>
        <knife4j.version>4.0.0</knife4j.version>
    </properties>
<dependencyManagement>
<!--            swagger-->
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
        <version>${springdoc.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-starter-webflux-api</artifactId>
        <version>${springdoc.version}</version>
    </dependency>
    <!--knife4j 分布式接口文檔聚合-->
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-gateway-spring-boot-starter</artifactId>
        <version>${knife4j.version}</version>
    </dependency>
</dependencyManagement>

gateway,因為gateway是基于webflux構(gòu)建的因此需要導(dǎo)入的是webflux版本的swagger依賴

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-gateway-spring-boot-starter</artifactId>
</dependency>
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webflux-api</artifactId>
    <scope>provided</scope>
</dependency>

服務(wù)server

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
</dependency>

配置文件編寫

服務(wù)server:

springdoc:
  swagger-ui:
    path: /swagger
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /服務(wù)名稱/api-docs

gateway:

gateway:
  discovery:
    locator:
      enabled: true
      #此處是配置服務(wù)的路由
  routes:
    #        XXX模塊
    - id: XXX-server
      uri: lb://XXX-server
      predicates:
        - Path=/XXX/**
        
knife4j:
  # 聚合swagger文檔
  gateway:
    enable: true
    routes:
    #此處需要與上面的配置對應(yīng)
      - name: XXX服務(wù)
        url: /XXX/api-docs?group=default
        service-name: XXX-server
        order: 1        

到此為止,knife4j文檔聚合就完成了

直接運行

啟動項目之后直接訪問gateway地址/doc.html即可

文章來源地址http://www.zghlxwxcb.cn/news/detail-536688.html

到了這里，關(guān)于knife4j實現(xiàn)微服務(wù)swagger文檔聚合的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！