Creating a REST API Document

Question

Is there a library that provides markup for writing REST API documentation? I have seen several companies use a similar documentation template, for example:

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. In essence, the library should create pages for API navigation, search and display (just like YARD for ruby ​​documentation) based on markup text.

This is what I have found so far:

• rapi_doc gem . The following is an article.

Answer 1

You should definitely take a look at Swagger .

This is Open Source, used by hundreds of APIs, and also used by 3scale in its API management solution called Active Docs.

Answer 2

Check out IO / Docs from Mashery.

I / O Documents Mashery I / O, the next generation of documentation and API research, allows developers to make direct API calls directly from your documents. Think of documents as testing and debugging, all in one convenient interactive interface.

Check out the Parse API Docs for another example of large documents.

In addition, we spent a lot of time developing FullContact API Documents . We also use the Apigee Live API Console .

Answer 3

This is a useful stone for documentaion api (Rails4 and Rails5)

ApiDoco https://rubygems.org/gems/apidoco/versions/1.2.0 .

It is very simple to set up and have a good user interface.