如何设置 Swashbuckle.AspNetCore 和 Oauth2

Question

我正在努力找出我哪里出错了。

services.AddSwaggerGen(options =>
{
    options.SwaggerDoc("v1", new Info { Title = "MySite API", Version = "v1" });
    options.OperationFilter<AuthorizeCheckOperationFilter>();
    options.OperationFilter<AddSwaggerHeadersOperationFilter>();
    options.AddSecurityDefinition("oauth2", new OAuth2Scheme
    {
        Type = "oauth2",
        Flow = "implicit",
        AuthorizationUrl = "authorization url",
        TokenUrl = "token url",
        Scopes = new Dictionary<string, string>()
        {
            { "scope", "Scope" }
        }
    });
});


//Configure Method
app.UseSwagger();

app.UseSwaggerUI(options =>
{
    options.SwaggerEndpoint("/swagger/v1/swagger.json", "MySite API V1");
    options.OAuthClientId("MyClientId");
    options.OAuthAppName("Swagger Api Calls");
    //c.RoutePrefix = string.Empty;
});

//AuthorizeCheckOperationFilter
internal class AuthorizeCheckOperationFilter : IOperationFilter
{
    public void Apply(Operation operation, OperationFilterContext context)
    {
        if (context.ApiDescription.TryGetMethodInfo(out var methodInfo))
        {
            var attributes = methodInfo.DeclaringType.GetTypeInfo().GetCustomAttributes(true);
            if (attributes.OfType<AuthorizeAttribute>().Any())
            {
                operation.Responses.Add("401", new Response { Description = "Unauthorized" });
                operation.Responses.Add("403", new Response { Description = "Forbidden" });

                operation.Security = new List<IDictionary<string, IEnumerable<string>>>();
                operation.Security.Add(new Dictionary<string, IEnumerable<string>>
                {
                    { "oauth2", new [] { "api1" } }
                });
            }
        }
    }
}

//Extra field
internal class AddSwaggerHeadersOperationFilter : IOperationFilter
{
    public void Apply(Operation operation, OperationFilterContext context)
    {
        if (operation.Parameters == null)
            operation.Parameters = new List<IParameter>();

        operation.Parameters.Add(new NonBodyParameter
        {
            Name = "SomeField",
            In = "header",
            Type = "string",
            Required = true,
            Default = "some value"
        });
    }
}

现在，当我打开 swagger 页面时，我会看到“授权”按钮，我单击该按钮并在那里填写详细信息后，我会被重定向到我的身份网站，该网站让我登录并立即重定向回 swagger。 Swagger然后说授权，好像一切都很好

然后我尝试使用 API，它需要传递不记名令牌，但它没有传递。我在 header 中没有看到它，并且根据我在身份网站上的日志，没有任何内容被传递。

知道为什么或如何解决这个问题吗？我正在使用 Swashbuckle.AspNetCore 4.1 包。

Answer 1

您可以添加 DocumentFilter :

public class SecurityRequirementsDocumentFilter : IDocumentFilter
{
    public void Apply(SwaggerDocument document, DocumentFilterContext context)
    {
        document.Security = new List<IDictionary<string, IEnumerable<string>>>()
        {
            new Dictionary<string, IEnumerable<string>>()
            {
                { "oauth2", new string[]{ "openid", "profile", "email" } },
            }
        };
    }
}

然后在AddSwaggerGen函数中注册过滤器：

options.DocumentFilter<SecurityRequirementsDocumentFilter>();

参考：https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/603#issuecomment-368487641

我用你的代码示例进行了测试，它按预期工作：

如何设置 Swashbuckle.AspNetCore 和 Oauth2

How to setup Swashbuckle.AspNetCore and Oauth2

oauth-2.0

swagger

swagger-ui

asp.net-core-mvc

swashbuckle