knife4j，微服务聚合Swagger文档

最新推荐文章于 2025-07-18 13:55:46 发布

原创

最新推荐文章于 2025-07-18 13:55:46 发布 · 2.1k 阅读

13 ·

CC 4.0 BY-SA版权

文章标签：

#微服务 #java #microservices

本文介绍了如何使用Spring Cloud Gateway和knife4j在微服务架构中实现API文档的聚合。通过Nacos作为注册中心，创建了micro-knife4j-gateway作为网关，聚合了micro-knife4j-user和micro-knife4j-order服务的Swagger文档。详细步骤包括服务的依赖配置、Swagger的集成以及如何在网关上实现文档切换。此外，还提供了如何切换回原始Swagger UI的方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前置知识

我们将采用Nacos作为注册中心，Gateway作为网关，使用knife4j来生成API文档，对这些技术不了解的朋友可以看下下面的文章。

应用架构

我们理想的解决方案应该是这样的，网关作为API文档的统一入口，网关聚合所有微服务的文档，通过在网关进行切换来实现对其他服务API文档的访问。

具体实现

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

micro-knife4j-user

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

在pom.xml中添加相关依赖，一个SpringBoot的web功能依赖，knife4j的微服务依赖（不包含API文档的前端UI包）；

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

在application.yml这添加相关配置，配置一下Nacos注册中心即可；

server:
  port: 9501
spring:
  profiles:
    active: dev
  application:
    name: micro-knife4j-user
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
management:
  endpoints:
    web:
      exposure:
        include: "*"

添加Swagger相关配置，非常常规的配置，添加@EnableKnife4j注解开启knife4j的增强功能。

/**
 * Swagger API相关配置
 */
@Configuration
@EnableSwagger2
@EnableKnife4j
public class Swagger2Config {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
      &nbs