Swagger

Swagger es nuestro modelo de API que les permitirá conocer las estructuras y definiciones de cada microservicio de nuestra capa de servicios, así como también les guiará en el uso de campos opcionales y obligatorios en la estructura JSON - DTO para consumir cada servicio.

Como utilizar Swagger

Los links de acceso a Swagger están definidos en el apartado de Entornos.

Cuando ingrese a Swagger la vista con la que se encontrará es la siguiente:

1. En la parte superior derecha encontrara la URL a la que está apuntando la API.

2. En la parte superior izquierda encontrará una lista desplegable donde podrá seleccionar el grupo de definiciones que requiere consultar.

3. En la parte inferior encontrará los distintos servicios que hay en el grupo de definiciones seleccionado.

4. Al ser servicios API REST encontrará el verbo con el cual se consumirá el servicio.

5. También encontrará el complemento de la URL para consumir el servicio seleccionado.

Note

Las palabras encerradas en llaves { userId } hacen referencia a los parámetros que se deben ingresar para consumir el servicio.

6. Si se requiere información más detallada se debe desplegar el servicio en el icono de flecha hacia abajo.

7. Luego de haber desplegado la información del servicio veremos la siguiente vista:

8. Se encontrará información detallada sobre los parámetros requeridos para el consumo del servicio y en caso de no requerir también nos informa.

9. Abajo de los parámetros encontraremos la estructura del body que se requiere para consumir el servicio junto con el tipo de dato que recibe el campo.

10. Si damos clic en Schema encontraremos más detalles sobre el request body, por ejemplo, los campos que tienen * son campos obligatorios.

11. Si scrolleas hacia abajo encontraras las posibles respuestas de nuestros servicios.

12. La primera respuesta que encontraremos es Success que nos indica que el servicio fue consumido exitosamente y no hubo ningún inconveniente.

13. Luego, encontraremos la respuesta Bad Request que nos indica que hubo uno o varios errores al consumir el servicio.

14. Ambas estructuras de respuesta cuentan con los mismos campos y definiciones, pero, solo se llenan las estructuras con la información pertinente de cada respuesta según su caso.

15. Si damos clic en Schema encontraremos más detalles sobre el response como sus campos y estructuras.