Как добавить пользовательские заголовки в документ NSwag, используя C # .NET CORE?

Question

Мне нужно добавить пользовательские заголовки, но я не могу понять это. Я пытаюсь использовать новые services.AddOpenApiDocument () вместо services.AddSwaggerDocument (). Я хочу добавить эти пользовательские заголовки ко всему API, а не к одному методу или контроллеру. Я попытался добавить операционный процессор, но при загрузке пользовательского интерфейса Swagger появляется следующая ошибка: «Не удалось отобразить этот компонент, см. Консоль».

Вот мой фрагмент внутри моего ConfigureServices():

    services.AddOpenApiDocument(document =>
    {
        ...
        // this works fine
        document.OperationProcessors.Add(new OperationSecurityScopeProcessor("Bearer"));
        document.DocumentProcessors.Add(new SecurityDefinitionAppender("Bearer", new SwaggerSecurityScheme
            {
                Type = SwaggerSecuritySchemeType.ApiKey,
                Name = "Authorization",
                In = SwaggerSecurityApiKeyLocation.Header
            })
        );

        // this is the header i want to show up for all endpoints that is breaking
        document.OperationProcessors.Add(new SampleHeaderOperationProcessor());
    });

Вот мой рабочий процессор:

public class SampleHeaderOperationProcessor : IOperationProcessor
{
    public Task<bool> ProcessAsync(OperationProcessorContext context)
    {
        context.OperationDescription.Operation.Parameters.Add(
            new SwaggerParameter {
                Name = "Sample",
                Kind = SwaggerParameterKind.Header,
                Type = NJsonSchema.JsonObjectType.String,
                IsRequired = false,
                Description = "This is a test header",
                Default = "{{\"field1\": \"value1\", \"field2\": \"value2\"}}"
            });

        return Task.FromResult(true);
    }
}

Единственное, что у меня есть к этому в моей Configure ():

    app.UseSwagger();
    app.UseSwaggerUi3();                              

Вот моя ошибка и журнал консоли: Моя ошибка и журнал консоли

Если это поможет, я использую ASP .NET CORE 2.2 и NSwag.AspNetCore v12.1.0

Answer 1

Это, наконец, сработало для меня. Решение напрямую от Rico Suter,

Попробуйте

Schema = new JsonSchema4 { Type = NJsonSchema.JsonObjectType.String }

вместо

Type = NJsonSchema.JsonObjectType.String

(я думаю, что Type не рекомендуется в OpenAPI 3)

Answer 2

Вот пример, который я реализовал в проекте.Для меня здесь все работает нормально:

Реализация интерфейса "IOperationProcessor":

using NSwag;
using NSwag.SwaggerGeneration.Processors;
using NSwag.SwaggerGeneration.Processors.Contexts;
using System.Threading.Tasks;

namespace api.mstiDFE._Helpers.Swagger
{
    public class AddRequiredHeaderParameter : IOperationProcessor
    {
        public Task<bool> ProcessAsync(OperationProcessorContext context)
        {
            context.OperationDescription.Operation.Parameters.Add(
            new SwaggerParameter
            {
                Name = "token",
                Kind = SwaggerParameterKind.Header,
                Type = NJsonSchema.JsonObjectType.String,
                IsRequired = false,
                Description = "Chave de acesso à API, fornecida pela RevendaCliente",
                Default = "Default Value"
            });

            return Task.FromResult(true);
        }
    }
}

Ссылка при запуске.CS:

internal static void ConfigureServices(IServiceCollection services, IConfiguration configuration)
{

    // Register the Swagger services
    services.AddSwaggerDocument(config =>
    {
        // Adds the "token" parameter in the request header, to authorize access to the APIs
        config.OperationProcessors.Add(new AddRequiredHeaderParameter());

        config.PostProcess = document =>
        {
            document.Info.Version = "v1";
            document.Info.Title = "Title ";
            document.Info.Description = "API para geração de Documentos Fiscais Eletrônicos (DF-e) do projeto SPED";
            document.Info.TermsOfService = "None";
            document.Info.Contact = new NSwag.SwaggerContact
            {
                Name = "Name",
                Email = "Email ",
                Url = "Url "
            };
            document.Info.License = new NSwag.SwaggerLicense
            {
                Name = "Use under LICX",
                Url = "https://example.com/license"
            };

        };
    });            
}