是否有专为创建 REST API 参考文档而设计的 CMS 引擎？
我正在创建一个 REST API，用于与我们正在构建的新 SaaS 网站连接，我们需要记录该 API，以供第三方 iOS 开发人员（以及服务公开后的其他开发人员）使用。是否有任何现有的数据库驱动的内容管理系统可以帮助为此类系统构建 API 文档？
我希望能提供比通用 wiki 或 WordPress 构建更定制的东西。
编辑：我可能应该提到我们的 VPS 设置为 LAMP 堆栈，因此 PHP 驱动的东西会更好。
自我记录不是必需的，我实际上想要更多手动的东西。我想使用 CMS 作为仍需要编写的 API 的设计平台。
I'm in the process of creating a REST API for interfacing with a new SaaS site we're building and we need to document the API for use by a third-party iOS developer (plus other developers once the service goes public). Are there any existing database driven content management systems that facilitate building API documentation for this type of system?
I'm hoping for something more tailored than a generic wiki or wordpress build would provide.
edit: I should probably mention that our VPS is setup as a LAMP stack, so something PHP driven would be preferable.
Self-documenting is not a requirement, I'm actually wanting something more manual. I'd like to use the CMS as a designing platform for APIs that still need to be written as well.
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（2）
I/O Docs是一个运行在nodejs上的交互式文档系统。您生成 API 的 JSON 模式，它提供一个 HTML/JS 站点来描述您的 API，并让开发人员可以通过浏览器实时使用它。
Swagger 是一个用于生成 API 文档的规范，也是一个用于运行您自己的文档站点的框架。
虽然不能替代文档，但 Apigee ToGo 将是对更通用的文档 CMS 的一个很好的补充。
Sphinx 不是面向 REST 的，但通常会生成文档。
如果您正在使用 Java 构建 API Eunciate 也值得关注。它将根据 JavaDocs 构建文档。
I/O Docs is an interactive documentation system running on nodejs. You generate a JSON schema of your API and it provides a HTML/JS site that describes your API and lets developers to play with it live from their browser.
Swagger is a specification for generating API docs and a framework for running your own documentation site.
While not a replacement for documentation Apigee ToGo would be a great addition to a more generic CMS for docs.
Sphinx isn't REST oriented but will generate documentation in general.
If you are building your API in Java Enunciate is something to look at as well. It will build documentation from JavaDocs.
Swagger 有一种“手动”方式来输入规格并生成文档。请在此处查看此答案： https://stackoverflow.com/a/12085196/411229
链接到示例项目：https://github.com/wordnik/swagger-core/tree/master/samples/no-server
Swagger has a "manual" way to enter your specs and generate documentation. See this answer here: https://stackoverflow.com/a/12085196/411229
Link to example project: https://github.com/wordnik/swagger-core/tree/master/samples/no-server