---
title: Criação de Documentação usando Swagger
slug: developer/criacao-de-documentacao-usando-swagger
description: Learn how to create documentation for a webservice using Swagger with this comprehensive document. Discover the best practices using the @Api annotation, tags property, and ApiTagsEnum to categorize your webservice effectively. Explore how to use annotati
createdAt: 2022-02-10T15:45:48.000Z
---

## Procedimento

Para criação da documentação de um webservice com a utilização de Swagger deve-se utilizar dos seguintes critérios:

- A classe que será documentada deve receber a anotação @Api do pacote *io.swagger.annotations.Api*, que consiste na identificação da categoria a qual o webservice se refere, como por exemplo: ticket, requisição de mudança etc.
- Dentro da anotação @Api, a propriedade *tags* é onde se deve colocar a identificação da categoria do webservice a qual recebe um valor do enum *ApiTagsEnum*.

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

- O enum *ApiTagsEnum* é o responsável por guardar as categorias ao qual o webservice pode pertencer. Cada enum é composto pelo valor do enum e uma instãncia da classe Tag (pacote *springfox.documentation.service.Tag*) que recebe o valor do enum e a descrição do que esse enum representa.

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

- Após a configuração desses cenários, para inserir a documentação do webservice de fato, deve se criar uma interface a qual o webservice relacionado deve implementar.

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

- Na interface é o lugar onde a documentação será escrita de fato. São utilizadas mais frequentemente as seguintes anotações:

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

- As demais anotações são as comumente utilizadas em um webservice criado utilizando o spring, que agora são trazidas para a interface para serem implementadas no webservice desejado.
- Para verificar se a documentação foi adicionada com sucesso, adicione *webmvc/swagger-ui.html#* após o *4biz* na url.

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

- Também é possível acessar diretamente a documentação do webservice desejado. Basta informar na url o path do webservice que deseja ver a documentação.

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