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

Question

我有一个功能完整的Web API项目。如何在最小努力的情况下将其改造为类似于Swagger文档/设计的样式？ http://petstore.swagger.wordnik.com/

Web API本身是否有原生的Swagger能力？

- GilliVilla

Answer 1

对于ASP.NET Web API，我推荐你使用“Swashbuckle”。这个实现通过简单的步骤简化了向任何Web API项目添加Swagger。基本上，你只需要安装Swashbuckle NuGet包并按照一些简单的说明操作即可。

Taiseer Joudeh撰写了文章“使用Swagger文档化ASP.NET Web API”，介绍了如何配置它。

另一个流行的实现是Swagger.net，但上次更新是在2年前，所以它似乎已经终止了。

- Xavier Egea

Answer 2

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

- Rico Suter

Answer 3

你也可以尝试使用Swank。它可以自动生成文档，支持XML注释、markdown、表情符号、约定等等：http://www.mikeobrien.net/swank/。

- hcoverlambda