SpringDoc OpenAPI 中如何配置多服务器URL

在基于Spring Boot和SpringDoc OpenAPI的项目开发中，我们经常需要为API文档配置多个服务器URL。本文将详细介绍如何在Swagger UI中实现这一需求。

核心配置方法

SpringDoc OpenAPI提供了多种方式来配置服务器URL，最直接的方式是通过OpenAPI Bean进行配置：

@Bean
public OpenAPI customOpenAPI() {
    return new OpenAPI()
            .info(new Info().title("API文档"))
            .servers(Arrays.asList(
                new Server().url("http://生产环境地址").description("生产环境"),
                new Server().url("http://测试环境地址").description("测试环境")
            ));
}

设计契约优先时的特殊处理

当采用契约优先(Design by Contract)的开发模式时，OpenAPI规范文件(yaml/json)中可能不包含服务器信息。这种情况下，SpringDoc仍然支持通过编程方式添加服务器配置。

与自定义OpenAPI文件结合使用

如果需要同时使用自定义的OpenAPI文件(springdoc.swagger-ui.url配置)和编程式服务器配置，可以通过以下方式实现：

1. 创建自定义的OpenAPI文件时保留servers部分为空
2. 通过上述Java配置方式动态添加服务器信息

高级配置选项

对于更复杂的需求，SpringDoc还支持：

• 使用SwaggerUiConfigProperties进行细粒度控制
• 实现OpenApiCustomiser接口进行自定义处理
• 通过环境变量动态配置服务器URL

最佳实践建议

1. 为不同环境(开发/测试/生产)配置不同的服务器URL
2. 为每个服务器添加清晰的描述信息
3. 考虑使用配置中心或环境变量来管理不同环境的服务器地址
4. 在契约优先开发中，保持规范文件的通用性，通过运行时配置添加环境特定信息

通过以上方法，开发者可以灵活地在SpringDoc OpenAPI项目中配置和管理多个服务器URL，满足不同环境下的API文档需求。