REST API document generation

Question

Is there a library that provides a markup for writing REST API documentation? I have seen several companies use similar documentation pattern, e.g:

http://api.teamlab.com/2.0/

http://www.fullcontact.com/docs/?category=person

I am wondering if they are using the same library or service. Essentially, the library should generate pages for API navigation, search and display ( much like YARD for ruby documentation) based on the markup text.

This is what I have found so far:

• rapi_doc gem. Here is an article discussing the usage.

Answer 1

You should definitely have a look at Swagger.

It is Open Source, used by hundreds of APIs and also used by 3scale in its API Management solution under the name Active Docs.

Answer 2

Check out IO/Docs from Mashery.

Mashery I/O Docs, the next generation of API documentation and exploration, let developers execute live API calls directly from your docs. Think docs meet testing and debugging, all in one convenient, interactive interface.

Check out the Parse API Docs for another example of great docs.

Also, we spent a lot of time designing the FullContact API Docs. We make use of the Apigee Live API Console as well.