如何使用 Swashbuckle 在 ASP.NET Core 中为 Swagger UI 进行 OAuth2 授权

Question

DotNet Core 2 中带有客户端凭据流的 Swashbuckle OAuth2 授权

我想设置隐式Flow，AuthorizationUrl，不同Scopes，默认选择Client-id， 所以，点击授权后，它应该导航到不同的选项卡，打开AuthorizationUrl 并使用户登录Swagger。所以，下次用户可以看到log out 选项。

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new Info()
    {
        Title = "",
        Description = "All rights reserved."
    });


    c.AddSecurityDefinition("oauth2", new OAuth2Scheme
    {
        Flow = "implicit",
        AuthorizationUrl = "https://...",
        Scopes = new Dictionary<string, string> {
            { "", "Read/Write" }
        }

    });
});

和Configure() 拥有，

app.UseSwagger();
app.UseSwaggerUI(c => {
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "iModelAcquisitionService");
});

Answer 1

您可以尝试以下步骤来启用隐式 Oauth2 流：

1. 更改 Startup.cs 并在 ConfigureServices 方法中替换之前添加的：

   services.AddSwaggerGen(c =>
   {
       c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
       c.AddSecurityDefinition("oauth2", new OAuth2Scheme
       {
           Type = "oauth2",
           Flow = "implicit",
           AuthorizationUrl = "https://login.microsoftonline.com/cb1c3f2e-a2dd-4fde-bf8f-f75ab18b21ac/oauth2/authorize",
           Scopes = new Dictionary<string, string>
           {
                   { "accessApi", "Access read operations" },
   
           },
           TokenUrl = "https://login.microsoftonline.com/cb1c3f2e-a2dd-4fde-bf8f-f75ab18b21ac/oauth2/token"
       });
   });
   

2. 并在 Configure 方法中替换以下内容：

   app.UseSwagger();
   app.UseSwaggerUI(c =>
   {
       c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
       c.OAuthClientId("19c73866-562f-482a-bafb-89d9fe9b0aaa");
       c.OAuthAppName("Swagger Api Calls");
   
   
   });
   

3. 进入swagger端点：http://localhost:xxx/swagger并点击Authorize按钮。