Spring Cloud Gateway + Knife4j 聚合API文档

TomSmile_WorkSpace

已于 2024-11-13 15:50:38 修改

阅读量1k

点赞数 20

分类专栏： SpringCloud 文章标签：微服务架构云原生

于 2024-11-13 15:47:48 首次发布

本文链接：https://blog.csdn.net/m0_64132144/article/details/143744991

版权

我们将采用Nacos作为注册中心，Gateway作为网关，使用Knife4j来生成API文档，该方案是目前来说最合理的微服务文档解决方案了。

应用架构

网关作为API文档的统一入口，网关聚合所有微服务的文档，通过在网关进行切换来实现对其他服务API文档的访问。

具体实现

下面详细介绍下Spring Cloud Gateway + Knife4j 聚合API文档的具体实现，依次搭建用户服务、订单服务和网关服务。

micro-knife4j-user

我们首先来搭建用户服务，一个普通的API服务，很简单，仅需三步即可集成Knife4j。

在pom.xml中添加相关依赖，一个SpringBoot的web功能依赖，Knife4j的依赖；

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    </dependency>
</dependencies>

在application.yml这添加相关配置，由于Knife4j底层使用的是SpringDoc，所以配置一下Nacos注册中心和SpringDoc即可；

server:
  port: 9501
spring:
  profiles:
    active: dev
  application:
    name: micro-knife4j-user
  mvc:
    pathmatch:
      matching-strategy: ANT_PATH_MATCHER
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
management:
  endpoints:
    web:
      exposure:
        include: "*"
springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
    show-extensions: true
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'default'
      paths-to-match: '/user/**'
      packages-to-scan: com.macro.cloud.controller
  default-flat-param-object: false

添加SpringDoc相关Java配置，非常常规的配置，和我们之前在SpringBoot中使用SpringDoc的配置没什么区别。

/**
 * @auther macrozheng
 * @description SpringDoc API文档相关配置
 * @date 2023/11/29
 * @git

最低0.47元/天解锁文章