-
Notifications
You must be signed in to change notification settings - Fork 0
Description
Contexto
- Atualmente não existe documentação da API.
Objetivo
Como uma pessoa desenvolvedora
Quero adicionar documentação da API
Para melhorar a experiência de quem for utilizar e manter essa API
Escopo
- Adicionar documentação da API no Swagger
Critérios de Aceitação
-
Documentação acessível
Dado que a aplicação está rodando
Quando acesso a URL padrão do Swagger (ex: /swagger ou /api-docs)
Então devo ver a interface do Swagger UI carregada
E devo conseguir visualizar a lista de endpoints disponíveis -
Atualizar a documentação automaticamente
Dado que faço uma alteração na definição de um endpoint
Quando reinicio a aplicação (ou buildo a documentação)
Então a documentação Swagger deve refletir essa alteração automaticamente -
Validar que todos os endpoints estão documentados
Dado que a API possui múltiplos endpoints
Quando acesso a documentação Swagger
Então devo ver todos os endpoints disponíveis na documentação
Metadata
Metadata
Assignees
Labels
Type
Projects
Status