Аутентификация JWT и Swagger с .Net core 3.0

Question

Я занимаюсь разработкой веб-интерфейса с .Net core 3.0 и хочу интегрировать его с SwashBuckle.Swagger. Он работает нормально, но когда я добавляю аутентификацию JWT, она не работает так, как я ожидаю. Для этого я добавил следующий код:

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

        });

После добавления функции AddSecurityDefinition я вижу кнопку «Авторизоваться» и, нажимая ее, я вижу форму ниже:

Затем я набираю Bearer WhatEverApiKeyIsfgdgdgdg845734987fgdhgiher635kjh. После этого я ожидаю увидеть authorization: Bearer WhatEverApiKeyIsfgdgdgdg845734987fgdhgiher635kjh в заголовке запроса, когда отправляю запрос в Web Api от Swagger. Но авторизация не добавляется в заголовок запроса. Я использую SwashBuckle.Swagger (5.0.0-rc3). Обратите внимание, что есть много примеров, которые отлично работают на .net core 2.0, но функции Swashbuckle swagger изменились в последней версии, поэтому я не могу использовать эти примеры.

Answer 1

После некоторого исследования я в конечном итоге нашел ответ здесь

До просмотра этой страницы я знал, что я должен использовать AddSecurityRequirement после AddSecurityDefinition из-за большого количества образцов, но этобыла проблема в том, что параметры функции изменились на .NET Core 3.0.

Кстати, окончательный ответ такой, как показано ниже:

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[] { } 
    } 
  });
});

Answer 2

Если вы не хотите добавлять токен вручную и хотите, чтобы области можно было выбирать вместе с передачей clientId на сервер идентификации, вы можете добавить что-то вроде этого.

Я использовал неявный поток,но вы можете настроить любой поток, используя следующий механизм:

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

Выход будет выглядеть так:

Answer 3

Если вы используете Swagger 3.0, он имеет встроенную поддержку для аутентификации JWT.

Вам необходимо использовать ParameterLocation.Header, SecuritySchemeType.Http, bearer и JWT в OpenApiSecurityScheme, как показано ниже.

После этого вам не нужно будет указывать токен в формате Bearer {token} . Укажите только токен, и схема безопасности автоматически применит его в заголовке.

// 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);