Slate es un excelente recurso para aquellos programadores que están diseñando y escribiendo su propia API. Slate está exclusivamente pensada para ser una plantilla gratuita para documentar API’s. Su formato es ideal para este trabajo. Además es suficientemente flexible para documentar los distintos estados que puede resolver las distintas solicitudes que comúnmente se realizan a las distintas APIs.
Plantilla gratuita para documentar API’s
Este proyecto es una excelente solución, tiene todo lo necesario para documentar de la mejor manera un API. Entre sus principales características podemos destacar:
- Buscador interno.
- Estructura optimizada para documentar un API para distintos lenguajes de programación mediante pestañas.
- Diseño perfectamente dividido por secciones que facilitan el aprendizaje.
- Opciones para remarcar funciones/aclaraciones.
- El diseño funciona como una pagina simple.
- Soporta la sintaxis de casi 60 lenguajes de programación distintos.
Requisitos:
- Ruby 1.9.3 o superior.
- Bundler.
La instalación es sencilla y se realiza directamente desde Bundler.
Si lo desean pueden ver una demostración en linea para ver la plantilla en funcionamiento. Así verificar que es lo que efectivamente necesitan.
Web: Slate