Tutorial Spring REST 6/9 – Configuración de Swagger 2 en Spring 4

1065

En este artículo mostramos cómo configurar Swagger 2 en un servicio REST de Spring 4 para generar documentación automática en HTML, de cada uno de nuestros end points, cada vez que se construya nuestro proyecto.

Dependencias de Maven

Primeramente, agregarémos las dependencias necesarias de Swagger con en su última versión hasta el momento 2.6.1.

Configuración de Swagger 2

Después, confiurarémos Swagger 2 dentro de una clase de configuración de Spring, en la cual especificarémos las URIs de las cuales se debe generar documentación y también información sobre el proyecto y el equipo de desarrollo.

Integración de Swagger con URIs del proyecto

Para mostrar la documentación autogenerada dentro de las URIs de nuestro proyecto, registrarémos el documento de HTML que Swagger 2 autogeneró en nuestro manejador de recursos.

En orden de acceder a la página de la documentación, redireccionaremos todo el tráfico de la págiana principal del proyecto a la de Swagger 2, en un controller de la siguiente forma.

Documentación HTML

Para generar comentarios específicos en nuestrs end points, usaremos la anotación @ApiOperation de Swagger 2 en cada uno de los métodos de los REST controllers que queramos documentar, de la siguiente forma.

Una vez completados los pasos anteriores, compilaremos y ejecutaremos nuestro proyecto e iremos al path principal de nuestro proyecto en donde encontraremos la documentación como se muestra acontinuación.

Podrás navegar en cada uno de los métodos, en donde se mostrará el verbo HTTP a usar, lo que hay que enviar, lo que recibirás, el formato de cada uno de ellos, además de permitirte lanzar los request a tu servicio desde la misma interfaz, sin necesidad de un cliente como Postman para ello.

Continua con el tutorial

Recuerda que esta serie cuenta con 9 tutoriales, puedes consultar el siguiente sobre pruebas de integración con JUnit a continuación:

Tutorial Spring REST 7/9 – Testing en Servicios REST con JUnit

Repositorio en Github

Nota que no todo el código del proyecto fue incluido en este artículo, puedes encontrar el código completo en nuestro repositorio de Github: https://github.com/chuucks/SPRING-REST-API/

Recuerda darnos una estrellita ?


La configuración de Swagger 2 con Spring 4 mostrada en este artículo para un servicio REST, es solo una forma propuesta de hacerlo y tienen fines únicamente ilustrativos para nuestra la comunidad de Codesolt.

Comments

comments