Criação de Documentação usando Swagger
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.
- 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.
- 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.
- Na interface é o lugar onde a documentação será escrita de fato. São utilizadas mais frequentemente as seguintes anotações:
- 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.
- 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.
