是否有任何 CMS 引擎旨在为 REST API 创建参考文档？ [关闭]答案

【问题标题】：Are there any CMS engines designed for creating reference documentation for a REST API? [closed]是否有任何 CMS 引擎旨在为 REST API 创建参考文档？ [关闭]
【发布时间】：2012-01-15 20:19:44
【问题描述】：

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

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

编辑：我可能应该提到我们的 VPS 设置为 LAMP 堆栈，所以 PHP 驱动的东西会更可取。

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

【问题讨论】：

标签： api rest documentation content-management-system

【解决方案1】：

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

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

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

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

如果您使用 Java 构建 API，Enunciate 也值得关注。它将从 JavaDocs 构建文档。

【讨论】：

生成不是必需的，实际上我宁愿手动输入它，因为这也将用于规划 API。感谢您的建议
我不知道有任何 CMS 是为 REST 文档设计的，但 Drupal 非常可扩展，而且 Google 协作平台非常易于使用。

【解决方案2】：

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

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

【讨论】：