问题标签 [swashbuckle]

我正在为使用 swagger/swashbuckle 在 Web Api 2 中实现的 api 生成文档。

唯一可识别的 xml 文档标签是<summary>,<remarks>和<param>.
这意味着我不能使用<para>标签在新的行或段落中格式化我的文本，所有内容都在文档的实施说明条目中生成为连续的长段落。

有没有办法做到这一点？

我用 Swashbuckle 配置了 ASP.NET WebApi 来显示招摇的用户界面。我在 IIS Express 的 VS 中运行它。该解决方案在 VS 2013 中运行良好。迁移到 VS 2015 后，大摇大摆地没有显示任何方法。没有错误，只是空列表。返回的响应是：

我检查了文档中的故障排除章节，但基于它，配置是可以的。接下来我可以尝试什么？

我将 Swashbuckle.Core 与 Asp.Net 一起使用，为我的 API 返回一个 IHttpActionResult。问题是 Swagger 中的响应返回的响应代码为 0，响应正文没有内容，但是当我通过邮递员进行相同的调用时，我重定向到的图像被返回并且响应代码为 200（这是我的行为想）。

招摇允许这样的重定向吗？是否有我缺少的设置或有关如何解决此问题的任何其他建议？

我返回的 IHttpActionResult：

编辑：

看起来这是一个已知的 Swagger 问题 https://github.com/swagger-api/swagger-ui/issues/549

我们使用 Swashbuckle/Swagger 作为 API 文档，通过 Nuget 安装。我们的 Web API 2 控制器有一个搜索端点：

当我运行项目并导航到 Swagger UI 时，它会选择所有其他操作（例如 Get、Put、Post 等），但 UI 中没有搜索操作的文档。我一直在谷歌搜索，但对于如何制作它以便搜索操作显示在 Swagger UI 中却一无所知。有什么想法吗？

谢谢！

我使用 Swagger(Swashbuckle) 作为我们 Web API 项目的文档工具。我可以使用自定义的 css 文件自定义 index.html。一切都很好，除了，我想在索引页面中添加我们公司的特定徽标，我无法让它工作。

建议？？

我最近提议使用 swashbuckle 将 swagger 集成到我们的 web-apis 中，以便在内部向我们的工程师公开 API 功能。出于我们的目的，swagger 在生产中没有意义，因为 api 是后端.....作为企业环境，api 的数量很大，我可以预见两个主要问题：

程序集大小约为 2.6MB：假设使用 swahbuckle 构建数百个 api，突然我们所有应用程序的大小增加了 4.5 倍。不合理的打击。查看 swashbuckle.core，我怀疑大部分大小来自捆绑的 swagger-ui。是否可以将 swagger-ui 从 swashbuckle 中解开，而是允许通过单独的 nuget 包添加 swagger-ui。

swashbuckle 中捆绑的 swagger-ui 让每个 api 都有自己的 swagger-ui 实​​例。对 swagger-ui 进行的任何定制对其他项目都没有影响，除非对每个单独的 api 项目都进行了更改，从而增加了工作量并降低了可维护性的机会。我们集中托管 swagger-ui 并进行定制，以允许开发人员在本地 (localhost) 尝试他们的 swagger 实现，因此受到 swashbuckle 集成 swagger-ui 的极大影响，如果可以选择将 swagger-ui 通过可选的单独的 nuget 包。

是否有任何东西可以解决上述问题，或者我们最好的机会是简单地分叉并以必须维护它为代价继续前进？

我熟悉 Microsoft 堆栈。我将 OData 用于我的一些宁静服务。最近我遇到了 Swagger for API 文档，我试图了解它与 OData 的关系。它们似乎都是 RESTful 规范。哪一种被广泛使用？

我正在尝试使用几个简单的控制器创建一个 WebApi 项目。如果我使用 fiddler 调用这些方法，一切都很好，但是我更喜欢使用 swashbuckle，因为它更漂亮一些。

但是，使用默认配置安装的 swashbuckle 无法正常工作。

当我导航到 http://localhost/api/mycontroller/swagger

它重定向到 http://localhost/api/mycontroller/swagger/ui/index

但它只显示以下错误：

<错误>
<消息>
未找到与请求 URI ' http://localhost/api/Management/swagger/ui/index ' 匹配的 HTTP 资源。
</Message>
<MessageDetail>
找不到与名为“swagger”的控制器匹配的类型。</MessageDetail>
</错误>

我的路由如下： config.MapHttpAttributeRoutes();

我一直在关注许多来源，尝试在我的 WebApi2 项目中实现 JWT 身份验证，并且还开始使用swagger.io和Swashbuckle来记录和测试我的 API。我受到了exceptionless如何支持一种/auth/login方法来生成api_key然后用于调用其他需要授权的方法的启发。

我还应该说我的开发基于ASP.NET Web API 2书，该书介绍了使用包的基于令牌的安全性JwtAuthForWebAPI，因此我为我实现了 JWT 委托处理程序，如下所示：

（我已经设置了 web.config 凭据并且代码步骤很好）

问题是：

1. 与异常不同，当我在输入 my 后调用方法时api_key，swagger 将密钥放在查询字符串上，而不是放在“Bearer”授权标头中
2. 我不知道上面的代码是否检查了 JWT 的查询字符串（即使这样做了，由于很多原因（安全性、长 URL）听起来并不明智
3. 因为上面的代码为我构建了委托处理程序，所以我无法调试它以查看它实际在做什么（我可以将log4net链接到它吗？）
4. 结果，我的控制器方法不会因为[Authorise]失败而受到打击。

我想我此时的问题是解决上面的第 1 项，这将使 2 成为非问题并且（希望）使 4 工作！谢谢。

我正在使用 swashbuckle 来记录我的 webapi 2.0 api。基本上没问题，对于我的用例来说已经足够了，但是有些事情我无法处理。CFRS - 好吧 - 关于 webapi 和 CSRF 的资源不多，但我认为拥有这种保护很重要。所以我通过自定义标头实现了它。现在我只是不能使用我的招摇用户界面——正因为如此。在 UI 中传递一些标头值会很棒。有可能吗？请帮忙