asp.net-core - 使用 Swashbuckle 时将全局项添加到 swagger.json

Question

我正在使用 Swashbuckle 生成一个 swagger 文件，然后将其上传到 Google Endpoints。

Google Endpoints 需要这两个参数（host 和 x-google-backend）

"host": "XXXX-ax7nuhuyua-uc.a.run.app",
"x-google-backend": {
    "address": "https://YYYY-dev-ax7nuhuyua-uc.a.run.app",
    "protocol": "h2"
},

这些需要添加到与 swagger、info、paths 相同的级别

有人能告诉我如何扩展 Swashbuckle 生成的 swagger 文件以包含这些全局参数吗？

使用 ASPNET 核心

标签： asp.net-coreswashbuckle

Answer 1

在这种情况下，您可以直接在in 中添加Extensions变量。Startup.csSwaggerDoc

services
    .AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo
        {
            // Any other properties

            Extensions = new Dictionary<string, IOpenApiExtension>
            {
                {
                    "x-google-backend", new OpenApiObject
                    {
                        {"address", new OpenApiString("https://YYYY-dev-ax7nuhuyua-uc.a.run.app")},
                        {"protocol", new OpenApiString("h2")}
                    }
                },
                {
                    "host", new OpenApiString("XXXX-ax7nuhuyua-uc.a.run.app")
                }
            }
        });
    });