REST Generación de documento API

Question

¿Hay una biblioteca que proporcione un marcado para escribir la documentación REST API? He visto varias empresas utilizan patrón de documentación similar, por ejemplo:

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

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

Me pregunto si están utilizando la misma biblioteca o servicio. Básicamente, la biblioteca debe generar páginas para navegación, búsqueda y visualización de API (muy similar a YARD para la documentación de ruby) en función del texto de marcado.

Esto es lo que he encontrado hasta ahora:

• rapi_doc gem. Aquí hay un article discutiendo el uso.

Answer 1

Sin duda, échele un vistazo a Swagger.

Es de código abierto, utilizado por cientos de API y también utilizado por 3scale en su solución de administración de API bajo el nombre de Active Docs.

Answer 2

Echa un vistazo IO/Docs de Mashery.

Mashery I/O Docs, la próxima generación de documentación y exploración de API, permite a los desarrolladores ejecutar llamadas API en vivo directamente desde sus documentos. Creo que los documentos cumplen con las pruebas y la depuración, todo en una interfaz práctica e interactiva.

Consulte el Parse API Docs para obtener otro ejemplo de excelentes documentos.

Además, pasamos mucho tiempo diseñando el FullContact API Docs. Hacemos uso del Apigee Live API Console también.

Answer 3

Esta es una joya útil para documentaion api (Rails4 y Rails5)

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

Es muy fácil de instalar y tener una buena experiencia de usuario.