| ... | ... | @@ -138,6 +138,9 @@ Para mais informações, leia [esta página](https://www.baeldung.com/java-valid |
|
|
|
|
|
|
|
A ferramenta Swagger (OpenAPI) já foi configurada na aplicação, para documentação da API e para permitir testar requisições HTTP via interface gráfica. Diante disso, novos *controllers* REST que forem criados já vão ser exibidos na [url do Swagger](http://localhost:8080/swagger-ui/index.html) sem precisar de nenhuma configuração adicional.
|
|
|
|
|
|
|
|
No entanto, para garantir que a API esteja bem documentada, sugere-se utilizar as anotações da API do Swagger para descrever melhor quais são os propósitos de cada *endpoint* e quais são os significados de cada parâmetro de requisição e código de resposta.
|
|
|
|
No entanto, para garantir que a API esteja bem documentada, sugere-se utilizar as anotações da API do Swagger para descrever melhor quais são os propósitos de cada *endpoint* e quais são os significados de cada parâmetro de requisição e código de resposta. Seguem alguns exemplos de anotação abaixo:
|
|
|
|
|
|
|
|
- @Operation: usada para descrever uma operação no Swagger (adicionar resumo, tags, etc)
|
|
|
|
- @Parameter: usada para descrever um parâmetro de uma requisição HTTP (propósito do parâmetro, exemplo de valor, etc)
|
|
|
|
|
|
|
|
Para mais informações, leia [esta página](https://springdoc.org/v1/). |
|
|
\ No newline at end of file |
