问题标签 [swashbuckle]

记录 OData 端点的最佳方式是什么？有没有办法使用 Swashbuckle 呢？

我现在确实需要我的 WebAPI 2 项目的 API 文档，并且我使用了 Swashbuckle 5 NuGet 包。开箱即用，我可以点击 {myrooturl}/swagger 并弹出一个 UI，但其中没有控制器、方法或任何东西。只是我的标题：[基本网址：/EM.Services，api 版本：v1]

我查看了 Swashbuckle 文档，由于我使用的是由 IIS 托管的 OWIN，因此我修改了 SwaggerConfig：

根据此文档：https ://github.com/domaindrivendev/Swashbuckle/blob/1326e753ce9b3a823b3c156b0b601134692ffc58/README.md#transitioning-to-swashbuckle-50

我还设置了项目的构建以生成 XML 文档并将我的 SwaggerConfig 指向它：

我不确定 XML 文档工作/不工作是否与它有关，因为我在 swagger-ui 页面上绝对没有控制器。

值得一提的是，我的所有控制器都继承自 BaseController，而 BaseController 又继承自 ApiController。

我的 WebApiConfig 有什么问题吗？

我的具体控制器看起来都是这样的（我尝试将 BaseController 替换为 ApiController 并且没有任何变化）：

而我的 Base 控制器（还）做的不多，只是有一个属性：

使用 IIS Express 或完整的 IIS 时，空白页面仍然存在。

更新：我制作的一个非常基本的人为控制器的示例。它也没有出现，因为我仍然有样板招摇 ui，里面什么都没有。

我正在组合一个需要匹配外部源 XML 格式的 Web API，并希望在 swagger 输出中重命名数据类型对象。

它在类的成员上工作正常，但我想知道是否也可以覆盖类名。

例子：

在生成的输出中，我最终看到了模型：

我希望看到

OVERRIDECLASSNAME { OVERRIDETHIS（字符串，可选）}

这可能吗？

谢谢，

我使用ASP.NET Web API 2.1 Custom Route Attributes在 Visual Studio 2015 中创建了一个新的 asp.net web api 2 项目。

我正在使用 Swagger (SwashBuckle 5.0) 获取 API 文档，并希望每个版本都有文档，我设法获得了这个文档，但是 swagger ui 显示两个版本的相同 xml 注释。

版本 1 和 2 的 api/view 上的 xml 注释有一些不同之处，这些注释没有出现在 swagger ui 上。

版本 1

版本 2

版本 1 控制器

版本 2 API 控制器

我创建了一个新的 Web Api 项目，添加了 Asp.Net Identity 并配置了 OAuth，如下所示：

这一切都很好，我可以调用 /Token 端点并取回不记名令牌。

问题是这在我假设的 Swagger 中是不可发现的，因为它不在控制器上，因此没有为它生成 xml 文档。

有谁知道在我的 Swagger 文档中显示此登录端点的方法？

谢谢。

另外，我应该说 Swagger 文档适用于我所有的控制器，只是我缺少一个明显的方法 - 如何登录。

我已将其纳入swagger-ui我的申请中。

当我尝试查看时，swagger-ui我很好地获得了 API 的文档，但过了一段时间它在按钮上显示了一些错误图标。

错误消息如下所示：

[{"level":"error","message":"无法读取文件 http://MYIP/swagger/docs/v1"}]

我不确定是什么原因造成的。如果我刷新它可以工作并在几秒钟后显示错误。

我是 swagger 的新手，我已经看过几个在线文档来实现 Swagger 到我的 webapi 并使用 SwaggerConfig 的一些属性进行自定义。

这是我的要求：-我只需要根据“API_Key”文本框的值在“探索”按钮单击时显示 swagger 文档，该值应与我的 app.config 键匹配。

所以我看到这样实现： -

1. 用户来到我的招摇主页，默认情况下它将有空文档，除了如图所示的标题。
2. 在标题中提供的文本框中输入 API_Key，然后单击浏览。
3. 输入的 API 密钥通过我的 app.config 中的密钥或 SwaggerConfig 中的密钥进行验证。
4. 如果验证显示文档，则将错误消息显示为无效的 API 密钥。

需要建议。

亲切的问候，拉古

我正在为模型使用数据合同，并且 datetime 数据成员工作正常，但是 swagger ui 将数据类型显示为字符串而不是 dateTime。

数据成员示例：

swashbuckle swagger-ui 模型输出：

开始日期（字符串，可选）：

我已经在我的 Web API 应用程序上成功实现了 Swashbuckle/Swagger，但对输出不满意。

我的一种 web api 方法（企业事件记录工具）接受复杂对象值的 JSON 对象。

问题是，当存在可以使用的可接受值的选定列表时，参数被列为字符串对象。我已经设置了默认值，因此如果发送了不正确的内容，我设置为默认值。

我想我可以添加其他返回可接受值的服务调用，但我宁愿不这样做。

我确实在 Swashbuckle 上实现了模式部分来设置一个有效的“示例”对象，但它只列出了可能一百种不同组合中的一种。

我可以给出的问题的最佳示例如下：

SourceSystem 可接受的值类似于“Accounting”或“Payments”或“Portal”。而公司的可接受值可能是“子公司 1”或“合作伙伴 1”。

有什么我可以添加到 Swashbuckle/Swagger 以将其输出到某处的吗？

我有 Swashbuckle 从我的 WebApi 服务生成的招摇。在类型等方面看起来一切都很好......但是当我使用 Azure API App 客户端生成代理类时，它缺少枚举声明。当我仔细检查时，它在招摇中，但在结果类中只有它们的字符串表示（字符串属性而不是枚举属性）并且没有枚举类型的声明。