Apiary.io Para Tus API’s

Apiary.io es un muy buen administrador editor, documentador y administrador de API’s, gratuito, fácil de usar, intuitivo, realmente estoy muy satisfecho, he realizado mi primer API y es genial. Comencemos por establecer la necesidad: Definición, documentación y mockeo de REST API’s. Apiary lo resuelve todo, tiene un editor para que en markdown documentes y definas tu api, guarda este archivo y sirve tu api en un subdominio, todo en un mismo paso.

Es realmente fácil crear una cuenta y empezar a crear tus apis, así como realmente sencillo documentar su definición, además de que no solo tienes tu archivo editado en MD, sino que renderiza automáticamente a HTML y los hospeda por ti, para que puedas simplemente enviar esta liga a tus desarrolladores de backend o a los desarrolladores de tus clientes como documentación para que implementen tu api. Todo en un mismo paso, en un mismo lugar.

Por si fuera poco, utilizando dredd puedes generar testeo de tus apis, no solo del mock, ya que puedes configurar el endpoint de tu sandbox o tu endpoint de producción y funcionará para hacer automáticamente tus pruebas de API, todo con el mismo archivo markdown que documenta, define y establece tus pruebas. Es realmente útil.

Su editor cuenta con un validador semántico que instantáneamente te mostrará errores y advertencias en el formato y contenido de tu api, la documentación sobre el formato que deben tener y las reglas para definir apis es clara, concisa, concreta, sencilla de leer y seguir, además de que cuenta con ejemplos suficientes.

Cuenta con sintaxis para establecer endpoints, métodos, parámetros, peticiones y respuestas, así como formatos esperados en ambas. Este es el core del api, lo básico que necesitas para definirla y ponerla en marcha. Tienes opción para poner los parámetros mandatorios u opcionales, y con valores por defecto, algo bastante útil para que dredd pueda generar las pruebas del api de manera automatizada.

Y esta es la cereza del pastel, de manera muy sencilla puedes generar tus pruebas automatizadas con dredd, son solo unos sencillos pasos desde su instalación y configuración, en menos de cinco minutos puedes obtener una robusta solución de pruebas de tu api. Es en este punto en el cual se valida tus jsons mock ups, algo que si he de decir me gustaría el mismo editor tuviera, que desde que estás escribiendo tus mock ups te valide tu json y no tengas que darte cuenta hasta que tus resultados de pruebas fallan.

Si, tiene puntos de mejora como el anteriormente citado, pero en general es una gran herramienta, útil, simple, completa y gratis, ya que su pricing comienza hasta que necesitas crear un equipo ¿Qué más puede uno pedir?