swagger - 使用 Swashbuckle Asp.Net Core for ReDoc 添加 x-logo 供应商扩展

Question

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

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

问题： 我能够添加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" };
            }

        }

• 将过滤器添加到SwaggerDocas

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 文件的正确部分提供的任何帮助或建议。

标签： swaggerasp.net-core-webapiswashbuckle

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",
                });
              }           

            }

        }