MobralBroker / MS-envio-de-dados

Project Stonks Solinftec - microsserviço para comunicação tem tempo real com front
0 stars 0 forks source link

Adição de Documentação para a API #1

Open AlexandreSout0 opened 10 months ago

AlexandreSout0 commented 10 months ago

Lista de Endpoints: Documentar todos os endpoints disponíveis na API, juntamente com suas finalidades e possíveis variações.

Parâmetros e Payloads: Especificar os parâmetros aceitos por cada endpoint, bem como os formatos de payload esperados e exemplos de solicitações.

Autenticação: Descrever os métodos de autenticação necessários para acessar a API, incluindo os tokens necessários e instruções claras sobre como obtê-los.

Respostas da API: Detalhar as diferentes respostas que a API pode retornar, incluindo os códigos de status, mensagens de erro possíveis e exemplos de respostas bem-sucedidas.

Exemplos de Uso: Fornecer exemplos práticos de como usar a API em diferentes cenários, destacando casos comuns de uso.

Limites e Restrições: Informar sobre possíveis limitações da API, como taxas de chamada, restrições de acesso, e quaisquer outras limitações importantes.