如何从Spring中生成的OpenAPI文档中排除"servers“部分？

在Spring中生成的OpenAPI文档中排除"servers"部分，可以通过自定义OpenAPI配置来实现。以下是详细的步骤和示例代码：

基础概念

OpenAPI（以前称为Swagger）是一种用于描述、生成、消费和可视化RESTful网络服务的机器可读接口文件格式。Spring Boot通过Springfox或Springdoc等库可以自动生成OpenAPI文档。

相关优势

• 标准化：OpenAPI提供了一种标准化的方法来描述API。
• 工具支持：许多工具（如Swagger UI、Postman）可以基于OpenAPI文档生成交互式API文档。
• 代码生成：可以基于OpenAPI文档自动生成客户端和服务端代码。

类型

• Springfox：一个流行的库，用于在Spring Boot应用程序中集成Swagger。
• Springdoc：另一个轻量级的库，用于生成OpenAPI文档。

应用场景

• API文档：为开发者提供详细的API文档。
• API测试：通过Swagger UI等工具进行API测试。
• 代码生成：基于OpenAPI文档生成客户端和服务端代码。

解决问题的方法

以下是使用Springdoc库排除"servers"部分的示例代码：

1. 添加依赖

在pom.xml中添加Springdoc依赖：

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.0.2</version>
</dependency>

2. 自定义OpenAPI配置

创建一个配置类来自定义OpenAPI文档，排除"servers"部分：

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.servers.Server;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.Collections;

@Configuration
public class OpenApiConfig {

    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .servers(Collections.emptyList()); // 排除servers部分
    }
}

参考链接

• Springdoc OpenAPI Documentation
• Springfox Documentation

通过上述配置，生成的OpenAPI文档中将不再包含"servers"部分。这样可以避免在文档中显示不必要的服务器信息。