是否有任何良好的自动化工具来记录REST API

Question

是否有任何自动化工具可以指向我们的WCF REST API并让它创建文档（最好带样本）？

Answer 1

看看Sandcastle项目。我们使用它来根据公共C＃成员上的///<summary>标记生成MSDN或JavaDoc样式的Html页面。

http://sandcastle.codeplex.com/

Answer 2

您使用的是网络Api吗？如果是这样，以下链接可以提供帮助

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

这是关于一般文档的内容。 http://blog.programmableweb.com/2010/08/12/web-api-documentation-best-practices/

Answer 3

您也可以使用Rest Assured library。 有关示例脚本的演示，请参阅http://artoftesting.com/automationTesting/restAPIAutomationGetRequest.html

Answer 4

尝试Swagger。

目前可能是最好的开源解决方案。它有很多可用于REST API文档的工具等等。