使用 Swagger 记录/设计 ASP.NET Web API答案

【问题标题】：Documenting /Designing ASP.NET Web API with Swagger使用 Swagger 记录/设计 ASP.NET Web API
【发布时间】：2014-10-10 19:34:25
【问题描述】：

我有一个功能性的 Web API 项目。我怎样才能以最小的努力对其进行改造，使其成为 Swagger 文档/设计之类的 http://petstore.swagger.wordnik.com/

是否有可用于 Web API 本身的原生 Swagger 类功能？

【问题讨论】：

【解决方案1】：

对于 ASP.NET Web API，我建议您使用“Swashbuckle”。此实现通过以下简单步骤简化了将 Swagger 添加到任何 Web API 项目的过程。基本上，您只需安装Swashbuckle NuGet package 并按照一些简单的说明进行操作。

Taiseer Joudeh 写了一篇关于如何配置它的帖子“ASP.NET Web API Documentation using Swagger”。

另一个流行的实现是Swagger.net，但最后一次更改是在 2 年前进行的，所以它似乎已停产。

【讨论】：

【解决方案2】：

您还可以使用NSwag 为现有的 Web API 控制器生成 Swagger 规范和客户端代码...有一个 Windows GUI 和命令行工具可以将这些工具集成到您的构建链中...

【讨论】：

【解决方案3】：

您也可以尝试 Swank。自动生成文档，支持 XML cmets、markdown、emojis、约定等：http://www.mikeobrien.net/swank/

【讨论】：