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

Question

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

我希望能够提供比通用wiki或wordpress构建更具针对性的东西.

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

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

Answer 1

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

Swagger是用于生成API文档的规范和用于运行您自己的文档站点的框架.

虽然不是文档的替代品,但Apigee ToGo将成为更通用的CMS文档的一个很好的补充.

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

如果您在Java中构建API,则还需要查看Enunciate.它将从JavaDocs构建文档.