在Swashbuckle（Swagger文档）中启用承载令牌

Question

我创建了一个ASP.NET webapi应用程序，该应用程序使用个人帐户安全性，因此在默认情况下启用承载令牌。它的工作很好，所以我可以测试他们在邮差没有问题。

当我试图通过Swashbuckle集成Swagger UI时，问题来了。我通过以下方式安装了Swashbuckle：

安装-封装Swashbuckle

然后更改swaggreconfig.cs：

GlobalConfiguration.Configuration
    .EnableSwagger(c =>
    {
        c.ApiKey("Token")
            .Description("Filling bearer token here")
            .Name("Authorization")
            .In("header");
    }
    .EnableSwaggerUi(c =>
    {
        c.EnableApiKeySupport("Authorization", "header");
    };

启动我的申请，填写不记名令牌：

但当我运行需要授权的api请求时，它就不起作用了。下面是截图：

将承载令牌添加到头中的授权中。但我还是得到了401号错误。我在想是不是因为令牌被编码了（空格被%20替换了）？知道吗？多谢了。

顺便说一下，我想知道如何在我的Swagger文档中添加/标记，以便我可以在Swagger UI中获得标记。

Answer 1

在ASP.NET framework Web API中，我能够在UI上添加承载令牌，并通过两种不同的方式使其正常工作。

添加操作Fitler。创建以下类：

public class AuthorizationHeaderParameterOperationFilter : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        if (operation.parameters == null)
        {
            operation.parameters = new List<Parameter>();
            
        }
        operation.parameters.Add(new Parameter
        {
            name = "Authorization",
            @in = "header",
            description = "access token",
            required = false,
            type = "string",
            @default = "Bearer "
        });
    }
}

现在在swaggerconfig.cs中添加以下内容：

GlobalConfiguration.Configuration
            .EnableSwagger(c =>
                {
                     // other settings

                     c.OperationFilter<AuthorizationHeaderParameterOperationFilter>();
             })
            .EnableSwaggerUi(c =>
                {
                    // UI configurations
            });

我们也可以使用DocumentFilter来迭代所有的操作并添加头，在下面的一个中，我们跳过了实际使用username和password并首次给出令牌的操作：

public class SwaggerPathDescriptionFilter : IDocumentFilter
{
    private string tokenUrlRoute = "Auth";
    // the above is the action which returns token against valid credentials
    private Dictionary<HeaderType, Parameter> headerDictionary;
    private enum HeaderType { TokenAuth };

    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
    {
        CreateHeadersDict();

        var allOtherPaths = swaggerDoc.paths.Where(entry => !entry.Key.Contains(tokenUrlRoute)) //get the other paths which expose API resources and require token auth
            .Select(entry => entry.Value)
            .ToList();

        foreach (var path in allOtherPaths)
        {
            AddHeadersToPath(path, HeaderType.TokenAuth);
        }
    }

    /// <summary>
    /// Adds the desired header descriptions to the path's parameter list
    /// </summary>
    private void AddHeadersToPath(PathItem path, params HeaderType[] headerTypes)
    {
        if (path.parameters != null)
        {
            path.parameters.Clear();
        }
        else
        {
            path.parameters = new List<Parameter>();
        }

        foreach (var type in headerTypes)
        {
            path.parameters.Add(headerDictionary[type]);
        }

    }

    /// <summary>
    /// Creates a dictionary containin all header descriptions
    /// </summary>
    private void CreateHeadersDict()
    {
        headerDictionary = new Dictionary<HeaderType, Parameter>();


        headerDictionary.Add(HeaderType.TokenAuth, new Parameter() //token auth header
        {
            name = "Authorization",
            @in = "header",
            type = "string",
            description = "Token Auth.",
            required = true,
            @default = "Bearer "
        });
    }
}

然后我们需要在swaggerconfig.cs：

GlobalConfiguration.Configuration
            .EnableSwagger(c =>
                {
                     // other settings

                     c.DocumentFilter<SwaggerPathDescriptionFilter>();
             })
            .EnableSwaggerUi(c =>
                {
                    // UI configurations
            });

现在我们将在swagger UI中看到标题的令牌输入，如下所示：

Answer 2

下面详述的问题现在在SwashBuckle5.5.0中得到了解决。

碰上了同样的问题。我认为根本原因是Swashbuckle源代码中的这一行：

var key = encodeURIComponent($('#input_apiKey')[0].value);

这是来自HTML输入字段的值通过URL编码将空格转换为%20的地方。我正计划在GitHub上开一个虚张声势的回购发行。

在这个问题得到解决之前，这里有一个解决方法，使用注入到Swagger UI中的Javascript文件替换上面的行：

>

在您安装了Swashbuckle的项目中，创建一个新文件夹并将其称为“Swagger”。

在new文件夹中创建一个名为“swaggeruicustoMization.js”的新Javascript文件，并将此脚本放入其中：

(function () {
    function addApiKeyAuthorization() {
        var key = $('#input_apiKey')[0].value;
        if (key && key.trim() != "") {
            var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization(swashbuckleConfig.apiKeyName, key, swashbuckleConfig.apiKeyIn);
            window.swaggerUi.api.clientAuthorizations.add("api_key", apiKeyAuth);
            log("added key " + key);
        }
    }
    $('#input_apiKey').change(addApiKeyAuthorization);
})();

在“解决方案资源管理器”中，选择该文件并单击Alt+Enter编辑其属性。在Properties窗口中，将文件的生成操作更改为Embedded Resource。

在您的swaggerconfig.cs文件中，在enableswaggerui()代码块中添加以下行:c.injectJavaScript(thisAssembly，“ .swagger.swaggeruicustomization.js”）；
当然，请确保将 替换为项目的默认命名空间。

运行您的项目并在文本框中输入“承载”。当您调用控制器操作时，您应该在服务器端获得这个完全相同的值--使用空格，而不是%20%。