是否有任何CMS引擎用于创建REST API的参考文档?

时间:2012-01-15 20:19:45

标签: api rest documentation content-management-system

我正在创建一个REST API,用于与我们正在构建的新SaaS站点进行交互,我们需要记录API以供第三方iOS开发人员(以及其他开发人员在服务上线后使用) )。是否有任何现有的数据库驱动的内容管理系统有助于为此类系统构建API文档?

我希望能够提供比通用wiki或wordpress构建更具量身定制的东西。

编辑:我应该提一下,我们的VPS设置为LAMP堆栈,所以PHP驱动的东西会更好。

自我记录不是必需的,我实际上想要更多手动的东西。我想将CMS用作仍然需要编写的API的设计平台。

2 个答案:

答案 0 :(得分:9)

I/O Docs是在nodejs上运行的交互式文档系统。您生成API的JSON模式,它提供了一个描述您的API的HTML / JS网站,并允许开发人员通过他们的浏览器实时播放。

Swagger是用于生成API文档的规范,以及用于运行您自己的文档站点的框架。

虽然不能替代文档Apigee ToGo,但对于更通用的文档CMS来说,这将是一个很好的补充。

Sphinx不是面向REST的,但通常会生成文档。

如果您正在使用Java Enunciate构建API,那么也需要注意。它将从JavaDocs构建文档。

答案 1 :(得分:0)

Swagger有一种“手动”方式来输入您的规格并生成文档。请在此处查看此答案:https://stackoverflow.com/a/12085196/411229

链接到示例项目:https://github.com/wordnik/swagger-core/tree/master/samples/no-server