5

我正在尝试 swagger( SwashBuckle ) 来生成 web api 文档。我已经使用 swagger 成功生成了使用 Web API 文档的文档，但我无法成功发送 API 请求，因为我们对少数方法具有基于令牌的身份验证（用于身份验证目的的自定义标头）。

我试图找出相同的示例代码/资源，但运气不佳。如果有人在他们的应用程序中实现/遇到类似的事情，请告诉我。

4

2 回答 2

8

我前段时间遇到了同样的问题，并在博客http://bitoftech.net/2014/08/25/asp-net-web-api-documentation-using-swagger/中询问了解决方案。

这是对我有用的答案：

1.添加名为“SwaggerExtensions”的新文件，然后添加名为“onComplete.js”的新JS文件，您必须将此文件的构建操作更改为“Embedded Resource”。

2.在文件“onComplete.js”中粘贴以下代码：

$('#input_apiKey').change(function () {

var key = $('#input_apiKey')[0].value;
if (key && key.trim() != "") {
key = "Bearer " + key;
window.authorizations.add("key", new ApiKeyAuthorization("Authorization", key, "header"));
}
});

3.打开文件“SwaggerConfig.cs”并在注册方法中粘贴以下代码：

SwaggerUiConfig.Customize(c =>
{
c.SupportHeaderParams = true;
c.InjectJavaScript(typeof(SwaggerConfig).Assembly, "AngularJSAuthentication.API.SwaggerExtensions.onComplete.js");
});

请注意，您需要更改完整的程序集名称以匹配您的程序集名称。

我相信就是这样，一旦你运行 UI，你会注意到这个文件已经下载，它会正确设置授权头。

于 2015-05-28T11:58:46.270 回答
4

您需要设置 API Key 授权。https://github.com/domaindrivendev/Swashbuckle的自述文件中的“描述安全/授权方案”对此有详细说明，但简而言之，您需要在调用 httpConfiguration.EnableSwagger() 时执行以下操作

c.ApiKey("apiKey")
  .Description("API Key Authentication")
  .Name("apiKey")
  .In("header");

然后，您需要创建从 IDocumentFilter 派生的自定义属性并将其应用于控制器中的适当方法。假设您将此称为 ApiKeyFilter。然后，您需要通过在 EnableSwagger() 中添加以下内容来向 Swagger 注册它

c.OperationFilter<ApiKeyFilter>();

我不知道 ApiKey 属性的示例代码，但我在 OAuth2 之前使用过https://github.com/domaindrivendev/Swashbuckle/blob/master/Swashbuckle.Dummy.Core/SwaggerExtensions/AssignOAuth2SecurityRequirements.cs，你应该能够适应这一点。

于 2015-05-28T11:45:09.677 回答