FastEndpoints项目中Swagger.json导出时缺失Servers配置的解决方案

在FastEndpoints项目开发过程中，开发者可能会遇到一个常见问题：当通过命令行工具导出Swagger.json文件时，生成的OpenAPI规范中会缺失servers配置段。本文将深入分析该问题的成因，并提供专业级的解决方案。

问题现象分析

在常规开发场景中，当开发者启动应用程序并直接访问Swagger UI时，生成的OpenAPI规范会包含正确的servers配置，例如：

"servers": [
    {
      "url": "http://localhost:5050"
    }
]

然而，当使用dotnet run --exportswaggerjson true命令导出Swagger.json文件时，该servers配置段却意外缺失。这种现象会导致导出的API文档无法正确反映服务的基础URL信息。

根本原因

经过技术分析，这个问题源于NSwag工具链的默认行为差异。NSwag在导出Swagger文档时，默认不会包含servers配置段，这与运行时生成的OpenAPI规范存在行为差异。

专业解决方案

FastEndpoints框架提供了灵活的文档处理器机制，允许开发者在文档生成阶段进行自定义处理。以下是推荐的解决方案实现：

1. 创建自定义文档处理器：

public class ServerConfigProcessor : IDocumentProcessor
{
    public void Process(DocumentProcessorContext context)
    {
        // 添加生产环境服务器地址
        context.Document.Servers.Add(new OpenApiServer
        {
            Url = "https://api.production.com",
            Description = "生产环境API服务"
        });
        
        // 添加测试环境服务器地址
        context.Document.Servers.Add(new OpenApiServer
        {
            Url = "https://api.staging.com",
            Description = "测试环境API服务"
        });
    }
}

2. 注册文档处理器： 在服务配置阶段，将自定义处理器添加到文档设置中：

services.SwaggerDocument(opt =>
{
    opt.DocumentSettings = settings =>
    {
        settings.DocumentProcessors.Add(new ServerConfigProcessor());
    };
});

高级配置建议

对于需要更复杂配置的场景，开发者还可以考虑以下进阶方案：

1. 环境感知配置：

public void Process(DocumentProcessorContext context)
{
    var env = Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT");
    
    context.Document.Servers.Add(new OpenApiServer
    {
        Url = env == "Production" 
            ? "https://api.production.com" 
            : "https://api.staging.com"
    });
}

2. 多环境支持：

context.Document.Servers.AddRange(new[]
{
    new OpenApiServer { Url = "https://api.production.com" },
    new OpenApiServer { Url = "https://api.staging.com" },
    new OpenApiServer { Url = "http://localhost:5050" }
});

注意事项

1. 文档处理器的Process方法会在每次文档生成时调用，包括运行时和导出时
2. 避免在文档处理器中执行耗时操作，以免影响文档生成性能
3. 对于需要动态配置的场景，建议使用依赖注入来获取配置信息

通过上述方案，开发者可以确保无论通过何种方式生成的Swagger文档，都能包含完整且正确的servers配置信息，为API使用者提供准确的端点访问地址。这种解决方案不仅解决了当前问题，还为未来的多环境支持提供了良好的扩展性。