用于记录/生成RESTful/HTTP RPC API的最佳工具是什么？

Question

关于基于REST/HTTP的API等已发布并回答了许多问题,但似乎没有关于以下问题的信息很多:

有哪些工具可用于记录HTTP-RPC API？哪种工具最好？

从2009年1月开始的类似问题(特定于ASP.NET)可以在这里找到,但没有答案.

我正在开发专业和个人项目(.NET MVC/OpenRasta,PHP,Coldfusion等)的几个API,我没有找到任何特别的东西来帮助记录这些API.我不是在寻找基于代码解析/擦除或类似的东西的自动生成.您可能已经知道基于RESTful/HTTP的API应该是客户端和平台无关的; 因此我希望任何文档工具都是一样的.

---

一个体面的工具可能具有的功能:

• 指定URL/URI格式/结构
• 请求/响应格式和方法(GET/POST/etc,XML/JSON/etc)
• 对端点/ API调用进行分类(例如在身份验证下对多个呼叫进行分组)
• 自动生成静态参考文件/文档,如下例所示
• 包括示例,测试用例等

---

以下是我认为合适的API文档/参考的一些示例:

http://dev.twitter.com/doc/post/statuses/destroy/:id

http://www.salesforce.com/us/developer/docs/api_rest/index.htm

http://www.flickr.com/services/api/

Answer 1

SWAGGER可能值得您一试.我使用它来记录使用Jersey的java应用程序公开的REST入口点,但看起来你也可以将它与其他语言一起使用.