Creación de Documentación con Swagger
5 min
Procedimiento
Para crear la documentación de un webservice utilizando Swagger, se deben utilizar los siguientes criterios:
- La clase que se va a documentar debe recibir la anotación @Api del paquete io.swagger.annotations.Api, que consiste en identificar la categoría a la que hace referencia el webservice, como por ejemplo: ticket, solicitud de cambio, etc.
Dentro de la anotación @Api, la propiedad tags es donde se debe colocar la identificación de la categoría del webservice, que recibe un valor de la enum ApiTagsEnum.
- La enumeración ApiTagsEnum se encarga de guardar las categorías a las que puede pertenecer el webservice. Cada enum se compone del valor del enum y una instancia de la clase Tag (paquete springfox.documentation.service.Tag) que recibe el valor del enum y la descripción de lo que representa este enum.
- Después de configurar estos escenarios, para insertar la documentación del webservice, es necesario crear una interfaz que debe implementar el webservice relacionado.
- La interfaz es donde se escribirá la documentación. Las siguientes anotaciones son las más utilizadas:
- Las otras anotaciones son las que se usan comúnmente en un webservice creado con Spring, que ahora se llevan a la interfaz para implementarse en el webservice deseado.
- Para verificar que la documentación se agregó correctamente, agregue webmvc/swagger-ui.html# después de 4biz en la URL.
- También es posible acceder directamente a la documentación del webservice deseado. Simplemente informe en la url el path del webservice que desea ver la documentación.
