Autenticação e Swagger JWT com .Net core 3.0

Estou desenvolvendo alguma API da Web com o .Net core 3.0 e quero integrá-la ao SwashBuckle.Swagger. Está funcionando bem, mas quando adiciono a autenticação JWT, não funciona conforme o esperado. Para fazer isso, adicionei o código abaixo:

  services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "My Web API", Version = "v1" });
            c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
            {
                Description = "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"",
                Name = "Authorization",
                In = ParameterLocation.Header,
                Type = SecuritySchemeType.ApiKey
            });

        });

Após adicionar a AddSecurityDefinitionfunção, vejo o botão Autorizar e, quando clico nele, vejo o formulário abaixo:

Então digito Bearer WhatEverApiKeyIsfgdgdgdg845734987fgdhgiher635kjh: Depois de fazer isso, espero ver authorization: Bearer WhatEverApiKeyIsfgdgdgdg845734987fgdhgiher635kjhno cabeçalho da solicitação, quando enviar uma solicitação para a API da Web do Swagger. Mas a autorização não é adicionada ao cabeçalho da solicitação. Estou usando o SwashBuckle.Swagger (5.0.0-rc3). Observe que existem muitos exemplos que funcionam bem no .net core 2.0, mas as funções do swashbuckle swagger foram alteradas na versão mais recente, portanto não posso usá-los.

Depois de alguma pesquisa, eu finalmente encontrei a resposta aqui

Antes de ver esta página, eu sabia que deveria usá-lo AddSecurityRequirementpor AddSecurityDefinitioncausa de muitos exemplos, mas era um problema que os parâmetros de função foram alterados no .NET Core 3.0.

A propósito, a resposta final é a seguinte:

services.AddSwaggerGen(c =>
{
  c.SwaggerDoc("v1", new OpenApiInfo { 
    Title = "My API", 
    Version = "v1" 
  });
  c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme {
    In = ParameterLocation.Header, 
    Description = "Please insert JWT with Bearer into field",
    Name = "Authorization",
    Type = SecuritySchemeType.ApiKey 
  });
  c.AddSecurityRequirement(new OpenApiSecurityRequirement {
   { 
     new OpenApiSecurityScheme 
     { 
       Reference = new OpenApiReference 
       { 
         Type = ReferenceType.SecurityScheme,
         Id = "Bearer" 
       } 
      },
      new string[] { } 
    } 
  });
});

Se você estiver usando o Swagger 3.0, ele possui suporte embutido para autenticação JWT.

Você precisa usar ParameterLocation.Header, SecuritySchemeType.Http, portador e JWT no OpenApiSecurityScheme, como mostrado abaixo.

Depois disso, você não precisaria especificar o token no formato Bearer {token} . Especifique apenas o token e o esquema de segurança o aplicará automaticamente no cabeçalho.

// Bearer token authentication
OpenApiSecurityScheme securityDefinition = new OpenApiSecurityScheme()
{
    Name = "Bearer",
    BearerFormat = "JWT",
    Scheme = "bearer",
    Description = "Specify the authorization token.",
    In = ParameterLocation.Header,
    Type = SecuritySchemeType.Http,
};
c.AddSecurityDefinition("jwt_auth", securityDefinition);

// Make sure swagger UI requires a Bearer token specified
OpenApiSecurityScheme securityScheme = new OpenApiSecurityScheme()
{
    Reference = new OpenApiReference()
    {
        Id = "jwt_auth",
        Type = ReferenceType.SecurityScheme
    }
};
OpenApiSecurityRequirement securityRequirements = new OpenApiSecurityRequirement()
{
    {securityScheme, new string[] { }},
};
c.AddSecurityRequirement(securityRequirements);

Se você não deseja adicionar um token manualmente e deseja que os escopos sejam selecionáveis ​​juntamente com a transmissão de um clientId para o servidor de identidade, você pode adicionar algo assim.

Eu usei fluxo implícito, mas você pode configurar qualquer fluxo usando o seguinte mecanismo:

options.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme()
{
  Flows = new OpenApiOAuthFlows
  {
    Implicit = new OpenApiOAuthFlow
    {                            
      AuthorizationUrl = new Uri("http://localhost"),
      TokenUrl = new Uri("http://localhost"),
      Scopes = new Dictionary<string, string>
      {
        { "Foundation API", "FoundationApi" }
      }
    }
  },
  In = ParameterLocation.Header,                    
  Name = "Authorization",
  Type = SecuritySchemeType.OAuth2                    
});

A saída será assim:

Aqui está uma solução atualizada para o Swashbuckle.AspNetCore 5.3.2, integrado ao IdentityServer4, com uma API protegida usando um token Bearer.

No ConfigureServices()método:

        services.AddSwaggerGen(options =>
        {
            options.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
            options.AddSecurityDefinition("Bearer", SecuritySchemes.BearerScheme(Configuration));
            options.AddSecurityRequirement(new OpenApiSecurityRequirement()
            {
                { SecuritySchemes.OAuthScheme, new List<string>() }
            });
        });

No Configure()método:

        app.UseSwaggerUI(options =>
        {
            options.SwaggerEndpoint("/My.Api/swagger/v1/swagger.json", "My API V1");
            options.OAuthClientId(Clients.TestClient);
            options.OAuthAppName("My Api - Swagger");
            options.OAuthClientSecret(Configuration["TestClientSecret"]);
        });

internal static class SecuritySchemes
{
    public static OpenApiSecurityScheme BearerScheme(IConfiguration config) => new OpenApiSecurityScheme
    {
        Type = SecuritySchemeType.OAuth2,
        Description = "Standard authorisation using the Bearer scheme. Example: \"bearer {token}\"",
        In = ParameterLocation.Header,
        Name = "Authorization",
        Scheme = "Bearer",
        OpenIdConnectUrl = new System.Uri($"{config["TokenServerUrl"]}.well-known/openid-configuration"),
        BearerFormat = "JWT",
        Flows = new OpenApiOAuthFlows
        {
            Password = new OpenApiOAuthFlow
            {
                AuthorizationUrl = new System.Uri($"{config["TokenServerUrl"]}connect/authorize"),
                Scopes = new Dictionary<string, string>
                    {
                        { Scopes.Api, "My Api" }
                    },
                TokenUrl = new System.Uri($"{config["TokenServerUrl"]}connect/token")
            }
        }
    };

    public static OpenApiSecurityScheme OAuthScheme => new OpenApiSecurityScheme
    {
        Reference = new OpenApiReference
        {
            Type = ReferenceType.SecurityScheme,
            Id = "Bearer"
        },
        Scheme = "oauth2",
        Name = "Bearer",
        In = ParameterLocation.Header,

    };
}

Se alguém estiver usando o NSwag e chegou aqui depois de pesquisar a solução, aqui está o link da documentação oficial.

NSwag Ativar autenticação JWT

PS: Eu sei que a pergunta original era para o SwashBuckle, mas o Google mostra esse link primeiro ao pesquisar pelo NSwag também.