http基本验证,带有swashbuckle api文档



任何人都知道我如何将基本auth与swashbuckle api的文档集成?

我看到SwaggerConfig文件中有一个基本功能:

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

我做了什么:

  • 毫不句子,但没有任何改变!

有人知道我想念什么吗?

谢谢!

@marwaahmad最佳答案的较小改进是检查null参数(例如,用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"
                });
            }
        }
    }

这是我做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的问题326Swashbuckle问题2

相关内容

最新更新