Documentação da API
A seção API Reference é gerada automaticamente a partir da especificação OpenAPI do Swagger. Todos os endpoints disponíveis no Swagger UI estão refletidos nesta documentação, que oferece uma visualização aprimorada e otimizada da mesma especificação técnica. A funcionalidade e os dados apresentados são idênticos, apenas com uma interface diferenciada para melhor experiência de consulta.A documentação sincroniza automaticamente com as alterações feitas no OpenAPI remoto, garantindo que qualquer atualização nos endpoints seja refletida imediatamente.
Links úteis
Swagger UI
Interface interativa do Swagger para testar os endpoints
OpenAPI (JSON)
Especificação OpenAPI em formato JSON
Sobre a especificação OpenAPI
A documentação desta API é baseada na especificação OpenAPI 3.0, que fornece:- Endpoints: Todos os endpoints disponíveis na API
- Parâmetros: Detalhes sobre parâmetros de requisição
- Schemas: Modelos de dados e estruturas
- Autenticação: Métodos de autenticação suportados
- Exemplos: Exemplos de requisição e resposta