我们正在使用ASP.NET Web API构建一个RESTful API项目。
我们正在寻找一种简单的方法来为我们在API中公开的每个方法调用自动生成文档,包括 - HTTP动词,URI,预期参数和样本方法有效载荷。
任何人都可以推荐一些工具和方法来完成ASP.NET Web API项目吗?
是否有工具可以做到这一点?或者它将成为一个有纪律的手动过程?
发布于 2018-03-19 11:45:21
webapi团队目前正在开发一个工具来生成文档。该工具被称为ApiExplorer。
这是一些官方文档:http : //www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages
有一个名为Swashbuckle的项目,它使用ApiExplorer生成Swagger Docs。(Github,Nuget)
发布于 2018-03-19 13:13:39
刚刚发布了一个名为Swank的OSS库就是这样做的。自动生成文档,支持XML评论,减价,表情符号,协定等:http : //www.mikeobrien.net/swank/
https://stackoverflow.com/questions/-100001474
复制相似问题