使用 Swashbuckle Asp.Net ReDoc 核心添加 x-logo 供应商扩展

Question

我正在使用 swagger.json 文件（由 Swashbuckle 生成）让 ReDoc 显示 API 文档。

我需要什么： 将 x-logo 供应商扩展添加到使用 Swashbuckle（Swashbuckle.AspNetCore.SwaggerGen 库）生成的 swagger json，以便 ReDoc UI 在左上角显示徽标 like this

问题： 我能够将 x-log 添加到 swagger.json 文件，但它被添加到文件的错误部分。它需要在 info 部分内。

这就是我添加 x-logo

创建了如下文档过滤器

    public class XLogoDocumentFilter : IDocumentFilter
        {
            public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
            {
              swaggerDoc.Extensions["x-logo"] = new { url = "https://URL/of/the/logo", altText = "Company Logo" };
            }

        }

将过滤器添加到 SwaggerDoc 作为

services.AddSwaggerGen(options => 
{   
  options.DocumentFilter<XLogoDocumentFilter>();

});

实际

    {
      "swagger": "2.0",
      "info": {
        "version": "v1",
        "title":"Sample REST API"
      },
      "x-logo": {
        "url": "https://rebilly.github.io/ReDoc/petstore-logo.png",
        "altText": "Aimia Logo"
      }
    }

预计

    {
      "swagger": "2.0",
      "info": {
        "version": "v1",
        "title":"Sample REST API",
        "x-logo": {
          "url": "https://rebilly.github.io/ReDoc/petstore-logo.png",
          "altText": "Aimia Logo"
        }
      },

    }

非常感谢任何帮助或建议将 x-logo 放入 swagger.json 文件的正确部分。

Answer 1

输入问题后，我自己找到了解决方案。不要将扩展名直接添加到 swaggerDoc，而是将其添加到 swaggerDoc.Info 对象。

public class XLogoDocumentFilter : IDocumentFilter
        {
            public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
            {   
              // need to check if extension already exists, otherwise swagger 
              // tries to re-add it and results in error  
              if (!swaggerDoc.Info.Extensions.ContainsKey("x-logo"))
              {
                 swaggerDoc.Info.Extensions.Add("x-logo", new {
                    url = "https://URL/To/The/Logo",
                    altText = "Logo",
                });
              }           

            }

        }

Answer 2

对于 .NET 核心 2.2 及更高版本

public class XLogoDocumentFilter : IDocumentFilter
{
    public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
    {
        // need to check if extension already exists, otherwise swagger 
        // tries to re-add it and results in error  
        if (!swaggerDoc.Info.Extensions.ContainsKey("x-logo"))
            swaggerDoc.Info.Extensions.Add("x-logo", new OpenApiObject
            {
                {"url", new OpenApiString("https://www.petstore.com/assets/images/logo.png")},
                {"backgroundColor", new OpenApiString("#FFFFFF")},
                {"altText", new OpenApiString("PetStore Logo")}
            });
    }

}

Answer 3

较新版本的 Swashbuckle 在 SwaggerDoc 设置中支持此功能：

c.SwaggerDoc("v1", new OpenApiInfo
{
  Title = ApiDescription,
  Version = "v1",
  Extensions = new Dictionary<string, IOpenApiExtension>
    {
      {"x-logo", new OpenApiObject
        {
           {"url", new OpenApiString("https://blah.com/logo")},
           { "altText", new OpenApiString("The Logo")}
        } 
      }
    }
});

使用 Swashbuckle Asp.Net ReDoc 核心添加 x-logo 供应商扩展

Adding x-logo vendor extension using Swashbuckle Asp.Net Core for ReDoc

swagger

swashbuckle

asp.net-core-webapi