ASP.NET Web API – 自动生成API文档

我们正在使用ASP.NET Web API构build一个RESTful API项目。

我们正在寻找一种简单的方法来为我们在API中公开的每个方法调用自动生成文档，包括HTTP动词，URI，预期参数和样本方法有效载荷。

任何人都可以推荐一些工具和方法，他们用来完成这个ASP.NET Web API项目？

是否有工具可以做到这一点？ 还是将是一个有纪律的手动过程？

Answer 1

webapi团队目前正在开发一个工具来生成文档。 该工具被称为ApiExplorer。

http://blogs.msdn.com/b/yaohuang1/archive/2012/05/13/asp-net-web-api-introducing-iapiexplorer-apiexplorer.aspx

http://blogs.msdn.com/b/yaohuang1/archive/2012/05/21/asp-net-web-api-generating-a-web-api-help-page-using-apiexplorer.aspx

更新：这是一些官方文件： http : //www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages

更新3/1/2015 – 有一个名为Swashbuckle的项目，它使用ApiExplorer来生成Swagger Docs。 （ Github ， Nuget ）

Answer 2

刚刚发布了一个名为Swank的OSS库。 自动生成文档，支持XML评论，减价，表情符号，协定等： http : //www.mikeobrien.net/swank/