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

问题描述

我正在创建一个REST API，用于与我们正在构建的新SaaS网站进行接口，我们需要记录API供第三方iOS开发人员使用（加上其他开发者一旦上市） ）。有没有任何现有的数据库驱动的内容管理系统可以促进为这种类型的系统构建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?

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

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

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

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.

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

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

虽然不是替换文档 Apigee ToGo 将是一个很好的补充更为通用的文档CMS。

While not a replacement for documentation Apigee ToGo would be a great addition to a more generic CMS for docs.

狮身人面像不是面向REST的，但会生成文档。

Sphinx isn't REST oriented but will generate documentation in general.

如果您正在Java中构建API Enunciate 也是要看的。它将从JavaDocs构建文档。

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

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