问题标签 [swashbuckle]

我有一个 webapi 运行（.net 4.5），帮助页面通过 ApiExplorer 加载我的所有 xml 注释。我现在想通过 swashbuckle 添加招摇。所以我安装了 swashbuckle nuget，但是当我浏览到我的端点时，我收到了 swashbuckle 文档建议的错误。

端点：localhost:1234/api/company/swagger 错误：{"Message":"Unauthorized request"} 或端点：localhost:1234/api/company/swagger/apidocs 错误：404 - 未找到

我错过了一步还是我做错了什么？

我正在使用库 Swashbuckle。目前没有它的stackoverflow标签。

我不太了解这里的文档：https ://github.com/domaindrivendev/Swashbuckle/blob/master/README.md

标题为“描述安全/授权方案”的部分提到了一段代码

但是，当我包含此内容时，什么也没有发生。我也希望它只出现在某些 API 方法上。它确实提到

“需要与文档中相应的“安全”属性相结合“

但我不明白这一点。

谁能解释一下？

有没有办法做到这一点？

我已经为我的其他 API 生成内容，但我不相信它适用于 SignalR。

I'm trying to install Swagger via the Nuget package (Swashbuckle) however I can't get it to work.

It's a vanilla VS 2013 Web Api 2 project. There is a single error on the JS console: Uncaught TypeError: Cannot read property 'tags' of null.

A 404 is received on the request for /swagger/ui/lib/underscore-min.map

I found a link that recommended disabling BrowserLink using vs:EnableBrowserLink in webconfig, but it didn't seem to have any effect.

Any ideas?

我正在尝试将 Swashbuckle 5.0.x 与 OAuth2 一起使用。我想使用 OAuth2 的资源所有者密码凭据授予。我基本上只想先请求一个令牌并将这个令牌包含在每个请求中（例如不需要范围）。

有人能帮忙吗？我必须如何配置 swagger/swashbuckle？

我正在使用 Swashbuckle 为 API 生成文档。我的控制器方法如下所示：

Swashbuckle 将HttpRequestMessage其视为生成文档中的参数。有没有办法将 Swashbuckle 配置为忽略HttpRequestMessage，因为它仅包含在签名中用于测试目的？

我正在使用新的 Azure API 应用程序（Visual Studio 2013 中的模板，带有 3/24/15 的新 SDK 位），我想让我的 Swagger UI 按版本号对我的调用进行分组。就我而言，我目前正在通过 URI 进行版本控制（我意识到 REST 纯粹主义者会告诉我不要这样做 - 请不要尝试在这里“纠正我的错误”）。例如，我可能有这些电话：

从功能上讲，这很好用！（是的，我知道你们中的一些人会畏缩。抱歉，这伤害了您的感受。）但是，我的问题是 W/Swagger UI 组织。默认情况下，Swagger UI 按控制器名称（Contacts在本例中）对这些进行分组。我在SwaggerConfig.cs文件中看到我可以改变这个：

我不明白的是如何调整它以将所有“最新”组合在一起，然后将所有 v1 组合在一起，然后将所有 v2 组合在一起，等等。

我怎样才能做到这一点？如果绝对必须要求我在路径中添加“最新”（或等效）一词来代替版本号，那么我可以这样做，但我不想这样做。

I'm trying to upgrade Swagger from 1.2 to 2.0 and I'm having issues getting the Operation type. In 1.2 the Operation Object included the Data Type Fields in order to describe the return value of the operation. But it doesn't look like this is the case for 2.0.

Is there a simple way to access an Operation Object's type?

我正在使用最新版本的 Swashbuckle 5.1.3 并注意到有一个新属性SwaggerResponse允许您记录每个响应代码的响应类型。例如：

（https://github.com/domaindrivendev/Swashbuckle/issues/175 < 可能有用）。

初始响应类记录得很好，但在它显示表格的更下方，"Response Messages"响应模型是空的（对于 400 Bad Request）。在屏幕上看不到记录了其他响应类型的任何地方。

我在我的 ASP.NET webapi 项目中使用所有默认设置的 Swashbuckle 5。它序列化我的方法的输出，以便向我显示回复的模式。我收到的文档如下所示：

这是通过以下 C# 代码生成的

其中 result.Results 基本上是一个标准的对象列表，每个对象都包含这些键/值/id 字段。我在这里读过https://conficient.wordpress.com/2014/05/22/getting-rid-of-k__backingfield-in-serialization/ [serializable] 属性可能会影响这一点，但我不愿意摆脱它属性，如果可能的话。有什么方法可以调整这个序列化工件吗？