Esta issue propõe a adição da documentação Swagger à API do projeto para melhorar a clareza, facilidade de uso e integração com outros sistemas.
Objetivo
Implementar a documentação Swagger para descrever de forma detalhada os endpoints, parâmetros, tipos de resposta e exemplos de uso da API.
Justificativa
A documentação Swagger oferece uma interface interativa que facilita a compreensão e teste dos endpoints da API. Ela padroniza a documentação, promovendo a consistência e facilitando a integração com ferramentas de terceiros. Além disso, simplifica o processo de onboarding para novos desenvolvedores e ajuda na manutenção contínua do sistema, garantindo que a API seja sempre bem documentada e atualizada.
Descrição
Esta issue propõe a adição da documentação Swagger à API do projeto para melhorar a clareza, facilidade de uso e integração com outros sistemas.
Objetivo
Implementar a documentação Swagger para descrever de forma detalhada os endpoints, parâmetros, tipos de resposta e exemplos de uso da API.
Justificativa
A documentação Swagger oferece uma interface interativa que facilita a compreensão e teste dos endpoints da API. Ela padroniza a documentação, promovendo a consistência e facilitando a integração com ferramentas de terceiros. Além disso, simplifica o processo de onboarding para novos desenvolvedores e ajuda na manutenção contínua do sistema, garantindo que a API seja sempre bem documentada e atualizada.
obs: Sugestão de utilização do módulo gin-swagger