SpringBoot 3.5 集成 Knife4j 4.3的详细步骤

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    <version>4.3.0</version>
</dependency>

# SpringDoc 原生配置
springdoc:
  swagger-ui:
    enabled: true
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    enabled: true
    path: /v3/api-docs
  group-configs:
    - group: default
      paths-to-match: '/**'
      packages-to-scan: com.example.controller
# Knife4j 增强配置
knife4j:
  enable: true
  setting:
    language: zh_cn
    enable-swagger-models: true
    swagger-model-name: 实体类列表

/**
 * OpenApi3在线接口文档组件初始化
 */
@Slf4j
@Configuration(proxyBeanMethods = false)
@ConditionalOnProperty(name = "springdoc.api-docs.enabled", matchIfMissing = true)
public class OpenApi3Config {
    @Bean
    public OpenAPI springDocOpenAPI() { 
        return new OpenAPI(SpecVersion.V30).info(new Info()
                                                 .title("API文档")
                                                 .description("简介")
                                                 .version("v1.0"))
        // 配置Authorizations
        .components(new Components()
                    .addSecuritySchemes("Authorization", new SecurityScheme().name("Authorization").in(SecurityScheme.In.HEADER).type(SecurityScheme.Type.APIKEY))
                    .addSecuritySchemes("TenandId", new SecurityScheme().name("TenandId").in(SecurityScheme.In.HEADER).type(SecurityScheme.Type.APIKEY)));
    } 
}

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
@RestController
@RequestMapping("/api/users")
@Tag(name = "用户管理")
public class UserController {
    @GetMapping("/{id}")
    @Operation(summary = "根据ID查询用户")
    public String getUser(@Parameter(description = "用户ID", required = true) @PathVariable Long id) {
        return "User " + id;
    }
}

@Schema(description = "用户信息")
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor 
public class UserInfo   { 
    /**
	 * 中文名
	 */
	@Schema(description = "中文名") 
	private String name;
}

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-gateway-spring-boot-starter</artifactId>
    <version>4.3.0</version>
</dependency>
<!-- 这里特别注意，只能引入 springdoc-openapi-starter-webflux-api ，
不要引入 springdoc-openapi-starter-webflux-ui, 
不然在 doc.html 会出现微服务下拉列表无法获取数据 -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webflux-api</artifactId>
    <version>2.8.15</version> 
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway-server-webflux</artifactId>
    <version>4.3.3</version> 
</dependency>

# 第二种配置方式：自动发现
knife4j:
  gateway:
    enabled: true
    # 指定聚合模式为服务发现（基于注册中心如 Nacos/Eureka）
    strategy: discover
    discover:
      enabled: true
      version: openapi3
# 第二种配置方式：手动配置
knife4j:
  gateway:
    enabled: true
    strategy: manual
    operations-sorter: order
    routes:
      - name: 用户服务
        context-path: /user
        url: /user/v3/api-docs/default
      - name: 订单管理
        context-path: /order
        url: /order/v3/api-docs/default