swashbuckle document csrf token。怎么通过呢?记录吗?

时间:2015-10-10 19:58:13

标签: c# asp.net-web-api swagger swashbuckle

我正在使用swashbuckle来记录我的webapi 2.0 api。它基本没问题,这对我的用例来说已经足够了,但有些东西是我无法处理的。 CFRS - 嗯 - 没有太多关于webapi和CSRF的资源,但我觉得有这种保护是很重要的。 所以我已经通过自定义标头实现了它。而现在我只是不能使用我的招摇ui - 因为那。在UI中传递一些标头值会很棒。它甚至可能吗?请帮忙

2 个答案:

答案 0 :(得分:0)

这个类本身并不是很好的文档,但我在swagger.config.cs中添加了我自己的类

c.OperationFilter<CsrfDocumentFiler>();

并像这样实现:

public class CsrfDocumentFiler: IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        if (operation.operationId != "Token_GetToken")
        {
            if (operation.parameters == null)
                operation.parameters = new List<Parameter>();

            operation.parameters.Add(new Parameter
            {
                name = "__RequestVerificationToken",
                @in = "header",
                type = "string",
                required = true
            });
        };
    }
}

答案 1 :(得分:0)

如果要过滤特定动词的所有操作并使用OperationFilterContext

c.OperationFilter<CsrfOperationFilter>();



public class CsrfOperationFilter : IOperationFilter
{
    /// <summary>
    /// Applies the specified operation.
    /// </summary>
    /// <param name="operation">The operation.</param>
    /// <param name="context">The context.</param>
    public void Apply(Operation operation, OperationFilterContext context)
    {
        if (string.Equals(context.ApiDescription.HttpMethod, "Get", System.StringComparison.OrdinalIgnoreCase))
        {
            return;
        }

        if (operation.Parameters == null)
        {
            operation.Parameters = new List<IParameter>();
        }

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