Are there any CMS mechanisms designed to create reference documentation for the REST API?

Question

I am creating a REST API to interact with the new SaaS site that we are creating, and we need to document the API for use by a third-party iOS developer (plus other developers after the service becomes publicly available). Are there existing database-based content management systems that facilitate the creation of API documentation for this type of system?

I hope for something more tailored than the generic wiki or wordpress build would provide.

edit: I should probably mention that our VPS is configured as a LAMP stack, so it would be preferable to use PHP.

Self-documentation is not a requirement, I really want something more manual. I would like to use CMS as a development platform for the APIs that still need to be written.

Answer 1

I / O Documents is an interactive documentation system that runs on nodes. You create a JSON diagram of your API and provide an HTML / JS site that describes your API and allows developers to play live with it from their browser.

Swagger is a specification for creating API documents and a framework for launching your own documentation site.

Without replacing documentation Apigee ToGo will be an excellent addition to the more general documentation CMS.

Sphinx is not REST oriented, but will generate documentation in general.

If you are building your API in Java Enunciate , this is also worth a look. He will create documentation from JavaDocs.

Answer 2

Swagger has a “manual” way of entering your specifications and creating documentation. See this answer here: stack overflow

Link to an example project: https://github.com/wordnik/swagger-core/tree/master/samples/no-server