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

Question

我有一个功能性的Web API项目。如何以极少的努力对Swagger文档/设计进行改造 http://petstore.swagger.wordnik.com/

是否有适用于Web API的本机Swagger功能？

Answer 1

对于ASP.NET Web API，我建议你＆＃34; Swashbuckle＆＃34;。此实现简化了通过以下简单步骤将Swagger添加到任何Web API项目。基本上，您只需安装Swashbuckle NuGet package并按照一些简单的说明操作即可。

Taiseer Joudeh写了这篇文章＆＃34; ASP.NET Web API Documentation using Swagger＆＃34;关于如何配置它。

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

Answer 2

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

Answer 3

您也可以尝试Swank。自动生成文档，支持XML注释，降价，表情符号，协约等：http://www.mikeobrien.net/swank/