使用Swasbuckle在web api的不同控制器中添加单独的自定义标头

Question

控制器名称：Controller1，自定义标头：Header1

应为特定控制器下的所有 API 显示标头

Answer 1

using Swashbuckle.Application;
using Swashbuckle.Swagger;
using System.Collections.Generic;
using System.Web.Http.Description;

Answer 2

这可以通过将 OperationFilter 添加到您的 swagger 配置中来解决。首先，您必须提供一个实现 IOperationFilter 的类。Apply方法接收一个操作参数，该参数在标记字段中包含控制器名称。呈现 Swagger UI 时，将为 API 中的每个方法调用 Apply方法。您甚至可以为每个 API 方法提供单独的参数，因为操作还包含操作 Id。

public class AddRequiredHeaderParameter : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        if (operation.parameters == null)
            operation.parameters = new List<Parameter>();

        if (operation.tags[0]?.CompareTo("Example") == 0)
        {
            operation.parameters.Add(new Parameter
            {
                name = "X-ExampleParam",
                @in = "header",
                @default = "42",  // optional default value, can be omitted
                type = "string",
                description = "My special parameter for the example API",
                required = true
            });
        }
        else if (operation.tags[0]?.CompareTo("Whatever") == 0)
        {
        // add other header parameters here
        }
    }
} 

在调试器中，使用名为＜code＞ExampleController＜/code＞的控制器，它如下所示：

通过在 SwaggerConfig 类的 Register 方法中添加一行来告诉 Swagger 使用 OperationFilter：

public class SwaggerConfig
{
    public static void Register(HttpConfiguration config)
    {
        var thisAssembly = typeof(SwaggerConfig).Assembly;

        //GlobalConfiguration.Configuration
        config
            .EnableSwagger(c =>
                {
                ... // omitted some lines here
                c.OperationFilter<AddRequiredHeaderParameter>(); // Add this line
                ... // omitted some lines here
                })

     } 

这个解决方案的想法是基于ShaTin的答案：如何在Swagger UI中发送带有请求的自定义标头？