Swagger: Una herramienta libre para la documentación y utilidades de los Servicios Rest

Swagger se ha convertido en una herramienta imprescindible a la hora de documentar un proyecto Rest que todo buen Desarrollador Backend debe conocer. En este artículo nos centraremos en las herramientas libres de Swagger.

Para poner en marcha estas herramientas necesitaremos tener instalado Docker y Docker Compose. Se puede instalar entro otros en Linux, MacOSX, incluso en Windows, pero esta última opción es la que menos te recomiendo, por lo complicado de su instalación debido a Hyper V, y porque dejarás de poder arrancar máquinas virtuales tanto de VirtualBox como de Vmware de manera normal.

Para poner manejar los contenedores descárgate o clona el repositorio https://github.com/pepesan/swagger-docker-compose los fichero mínimos.

Una vez bajados debería bastar con ejecutar:

docker-compose up -d

Para ver si están levantados los contenedores:

docker-compose ps

Para parar los contendores:

docker-compose down

Si todo va correcto deberías poder acceder a la URL: http://localhost:8081/ y deberías encontrar el editor de swagger.

A partir de este momento ya puede empezar a jugar con el editor para cambiar la especificación y ver cómo queda la documentación generada.

captura de pantalla del swagger editor

Luego podrás exportar el fichero en JSON o YAML desde el menú File, generar clientes o servidores basados esa especificación desde los menús Generate Client y Generate Server respectivamente.

Si te interesan estos temas te recomiendo que visites el blog o el podcast de república web, episodio 108 donde comentamos esta herramienta y otros temas muy interesantes.

Comments

Leave a Reply

*

XHTML: You can use these tags: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.

Categorías de Cursos

Suscríbete al Boletín

Si quieres estar al tanto de las novedades del blog, ya sabes :)
* = campo obligatorio

powered by MailChimp!

Si estás interesado en seguir formándote tenemos una serie de cursos gratuitos: http://cursosdedesarrollo.com/cursos/

También disponemos de algunos cursos de pago por si son de tu interés: https://cursosdedesarrollo.com/tienda/

Curso de Angular: https://cursosdedesarrollo.com/tienda/angular/

Uso de cookies

Este sitio web utiliza cookies para que usted tenga la mejor experiencia de usuario. Si continúa navegando está dando su consentimiento para la aceptación de las mencionadas cookies y la aceptación de nuestra política de cookies, pinche el enlace para mayor información. ACEPTAR

Aviso de cookies