我正在创建一个 REST API,用于与我们正在构建的新 SaaS 网站连接,我们需要记录该 API,以供第三方 iOS 开发人员(以及服务公开后的其他开发人员)使用。 是否有任何现有的数据库驱动的内容管理系统可以帮助为此类系统构建 API 文档?
我希望能提供比通用 wiki 或 WordPress 构建更定制的东西。
编辑:我可能应该提到我们的 VPS 设置为 LAMP 堆栈,因此 PHP 驱动的东西会更好。
自我记录不是必需的,我实际上想要更多手动的东西。 我想使用 CMS 作为仍需要编写的 API 的设计平台。
I/O Docs是一个运行在nodejs上的交互式文档系统。您生成 API 的 JSON 模式,它提供一个 HTML/JS 站点来描述您的 API,并让开发人员可以通过浏览器实时使用它。
Swagger 是生成 API 文档的规范,也是运行您自己的文档站点的框架。
虽然不是文档的替代品,但Apigee ToGo 将是对更通用的文档 CMS 的一个很好的补充。
Sphinx 不是面向 REST 的,但通常会生成文档。
如果您正在用 Java 构建 API,Enunciate 也值得关注。它将从 JavaDocs 构建文档。
Swagger 有一种“手动”方式来输入规格并生成文档。 在这里查看这个答案:https://stackoverflow.com/a/12085196/411229
示例项目链接:https://github.com/wordnik/swagger-core/tree/master/samples/no-server