有没有针对创建REST API参考文档设计的CMS引擎？

Question

4

我正在创建一个REST API，用于与我们正在构建的新SaaS网站进行接口交互，并且我们需要为第三方iOS开发人员（以及服务公开后的其他开发人员）记录API文档。有没有任何现有的基于数据库驱动的内容管理系统，可以方便地为这种类型的系统构建API文档？

我希望找到比通用维基或WordPress更适合的东西。

编辑：我应该提到我们的VPS已设置为LAMP堆栈，因此最好使用一些PHP驱动的东西。

自记录并不是必需的，实际上我需要的是更手动的方法。我想使用CMS作为API设计平台，同时仍需要编写API。

- Twipped

2个回答

0

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

- Ryan Walls

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- abraham · Accepted Answer

I/O Docs 是一个运行在nodejs上的交互式文档系统。您只需生成API的JSON模式，它就会提供一个HTML/JS页面来描述您的API，并让开发人员可以直接从浏览器中实时测试API。

Swagger是一个生成API文档和运行自己文档站点的框架的规范。

Apigee ToGo虽然不能替代文档，但作为通用CMS文档的一个很好的补充。

Sphinx不是面向REST的，但可以生成一般性的文档。

如果您正在使用Java构建API，则可以考虑使用Enunciate，它可以从JavaDocs中构建文档。