---
title: Creación de Documentación con Swagger
slug: dev-es/creacion-de-documentacion-con-swagger
description: Learn how to create comprehensive documentation for your webservice using Swagger with this step-by-step guide. Discover essential steps like utilizing the @Api annotation, leveraging the tags property, implementing an enumeration to categorize your API, 
createdAt: 2022-06-26T18:39:06.000Z
---

## 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*.

::Image[]{src="https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/E5bLjrXSQK11CybLPDoQD_prbchywogczavs79gks1iimage1.png" size="90" width="1738" height="478" position="center" showCaption="false"}

- 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.

::Image[]{src="https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/J8JePi4OlnJh_0xPyMC34_bwjx3tja1xi6j9wctvhlbimage2.png" size="90" width="1358" height="292" position="center" showCaption="false"}

- Después de configurar estos escenarios, para insertar la documentación del webservice, es necesario crear una interfaz que debe implementar el webservice relacionado.

::Image[]{src="https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/bIM4daGEEHdK9qKvtPBUJ_7z6weakzgi82jropbr6oimage3.png" size="90" width="1354" height="206" position="center" showCaption="false"}

- La interfaz es donde se escribirá la documentación. Las siguientes anotaciones son las más utilizadas:

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/Hk3rycQVuEFN2LOu5hNs4_gdcvsy86s5r655qsdxyqjimage4.png)

- 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.

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/BDgN0-cSjVZ4B8hxsNUgG_1qzsgl0pjk7im-vtltyd8image5.png)

- 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.

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/1DHVeMq8zTUA5eyD4VknE_vztzveddp71zyljq3ihpoimage6.png)