是否有任何CMS引擎设计的REST API创建参考文档？ [英] Are there any CMS engines designed for creating reference documentation for a REST API?

问题描述

我在与我们正在建设一个新的SaaS网站接口创建一个REST API的过程中，我们需要通过第三方的iOS开发者（以及其他开发人员进行归档，以使用API​​各服一次公开上市）。是否有利于此类系统的建设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?

我希望的东西比一般的维基或字preSS版本将提供更多量身定制的。

I'm hoping for something more tailored than a generic wiki or wordpress build would provide.

编辑：我也许应该提到我们的VPS是设置为A的LAMP堆栈，所以一些PHP驱动将是preferable

edit: I should probably mention that our VPS is setup as a LAMP stack, so something PHP driven would be preferable.

自记录文件是不是必需的，实际上，我想更多的东西手册。我想使用CMS作为一个设计平台，仍然需要写成良好的API。

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.

推荐答案

I / O文档是交互式文档系统上运行的NodeJS。您生成您的API的JSON模式，它提供了一个描述你的API，并让开发者与直播从他们的浏览器中播放HTML / JS的网站。

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.

扬鞭是用于生成API文档和运行自己的文档的网站框架的规范。

Swagger is a specification for generating API docs and a framework for running your own documentation site.

虽然不是文档 Apigee多哥更换将是一个伟大的除了一个更通用的CMS对于文档。

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.

如果您正在构建的API在Java中字正腔圆是东西看为好。它将从建立的JavaDocs文档。

If you are building your API in Java Enunciate is something to look at as well. It will build documentation from JavaDocs.

这篇关于是否有任何CMS引擎设计的REST API创建参考文档？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！