REST风格的JSON API文档生成器

我想知道如果任何人有任何经验或build议的工具，可以用来生成网页文件，并让您玩RESTful JSON API。我正在考虑像Github开发人员API或Google API控制台。

环顾四周，我发现从Wordnik中看起来不错。但是我想知道是否还有其他的东西，以及这些工具的用户体验。谢谢。

还有其他的东西，如发音和I / O文件。

这里是关于这个主题的博客： REST API的自动文档

我喜欢养蜂。仍然在不断变化，但看起来相当不错。

这个问题是相当古老的，但我相信仍然是实际的。我知道三个APIdevise工具：

Swagger（没有SaaS解决scheme）
RAML（apihub.com）
API蓝图（apiary.com）所有这些都包含在这篇博文中 – http://apievangelist.com/2014/03/08/hello-world-product-api-with-blueprint-raml-and-swagger/
如果您对API感兴趣，我强烈build议跟随这个人

我个人认为这些工具适合于在相对较小的开发团队的成员之间共享API文档，每个开发人员都知道特定项目的大部分细节，他们实际上只需要知道它是POST还是PUT，什么是名称结果JSON字段。

我们需要有丰富和方便的内容pipe理function以及REST特定的东西，这些东西可以生成各种格式的美丽文档，如单页html或pdf我们找不到像样的软件，因此我们决定创buildSpeca.io

目前它是在阿尔法和完全免费的，但我们非常欢迎发挥出来，任何反馈将不胜感激。

Swagger可能适合你。它有各种语言的实现。

我的build议是不要太信任[来自源代码的文档]生成器。我认为文档的受众最终是人类，他们需要的东西比WADL和机器生成的文件所能提供的要多得多。为了帮助这些工具，你必须投入时间和精力来掌握工具的偏差。

另外，API的源代码中可以包含多less实际的限制。只logging参数名称和types不会有太大的帮助（和完整），并且在源代码中添加样例请求和响应看起来非常糟糕（尽pipe对于最终用户而言是必不可less的信息）。另一个原因可以是简单的美学。

Twitter也手工维护这些文件，这是很有说服力的。恕我直言，最好的select将是维护文件在一些人性化的格式，并生成HTML / PDF等。

无耻的插头

这只是一些非常简单的PHP脚本，它们从YAML定义文件读取API并生成HTML。对于EBaytypes的庞大API，可能不能很好地扩展，但对于简单的API文档要求，这可能是一种方法。

我们正在研究适用于Java / Jax-rs的MireDot 。初始设置不到5分钟。一个非常强大的基础版本是免费的。

rest-tool是使用Node.js在JavaScript中编写的简单的命令行工具。它可以创build独立的项目，提供RESTful API的文档，仿真和自动化testing。

您可以在几分钟内创build工作API，作为前端和后端开发人员之间的DMZ。

它基于模板生成文档，testing用例甚至服务器端dynamic模拟逻辑，所以一切都是高度可定制的。

我刚刚创build了一个ruby gem“calamum”，生成一个html rest API文件，使用起来很简单。 https://github.com/malachheb/calamum 。

我刚刚创build了Swadl，一个摇摆式启发的WADL文档生成器。

基本上，根本就没有集成 – 只是把它传给你的wadl并生成页面。

看看这里： https ： //github.com/ehearty/Swadl

并在这里看到一个演示： http : //ehearty.github.io/Swadl/wadl.html

我喜欢我的工具反馈