http basic auth with swashbuckle api 文档

Question

谁能知道我如何将基本身份验证与 swashbuckle api 的文档集成？

我看到 swaggerconfig 文件中有一个 basicAuth 函数：

    c.BasicAuth("basic").Description("Basic HTTP Authentication");

我做了什么：

取消注释前一行但没有任何改变！

有人知道我错过了什么吗？

谢谢！

Answer 1

这是我进行 httpbasic 身份验证的方式：

public class AddAuthorizationHeaderParameterOperationFilter: IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        var filterPipeline = apiDescription.ActionDescriptor.GetFilterPipeline();
        var isAuthorized = filterPipeline
                                         .Select(filterInfo => filterInfo.Instance)
                                         .Any(filter => filter is IAuthorizationFilter);

        var allowAnonymous = apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any();

        if (isAuthorized && !allowAnonymous)
        {
            operation.parameters.Add(new Parameter {
                name = "Authorization",
                @in = "header",
                description = "access token",
                required = true,
                type = "string"                    
            });
        }
    }
}

api的用户应在字段值中写入：basic [un:pw].tobase64.

参考资料： swashbuckle's issue 326 swashbuckle issue 2

Answer 2

对@MarwaAhmad 最出色的答案的一个小改进是检查空参数（例如，一个简单的 GET 或调用 URL 中的所有参数）。还添加了基本身份验证的详细信息。

此外，如果您已经使用全局 IAuthorizationFilter 来强制执行 HTTPS，那么您将需要更改更通用的

filter => filter is IAuthorizationFilter

具体

filter => filter is AuthorizeAttribute

    public class AddAuthorizationHeaderParameterOperationFilter : IOperationFilter
    {
        public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
        {
            var filterPipeline = apiDescription.ActionDescriptor.GetFilterPipeline();
            var isAuthorized = filterPipeline.Select(filterInfo => filterInfo.Instance)
                .Any(filter => filter is IAuthorizationFilter);

            var allowAnonymous =
                apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any();

            if (isAuthorized && !allowAnonymous)
            {
                if (operation.parameters == null)
                    operation.parameters = new List<Parameter>();

                operation.parameters?.Add(new Parameter
                {
                    name = "Authorization",
                    @in = "header",
                    description = "Basic HTTP Base64 encoded Header Authorization",
                    required = true,
                    type = "string"
                });
            }
        }
    }

http basic auth with swashbuckle api 文档

http basic auth with swashbuckle api documentation

asp.net-web-api

swagger

swashbuckle