Referência da API
A referência técnica do Conota é gerada a partir da especificação OpenAPI:
Use para consultar:
- endpoints e métodos HTTP;
- parâmetros e campos obrigatórios;
- schemas de requisição e resposta;
- enums e seus valores;
- exemplos;
- códigos de retorno.
A divisão de trabalho
| Este portal | como integrar — conceitos, fluxos, decisões |
| ReDoc | o contrato exato da API |
Por que não copiamos as tabelas de campos para cá
O OpenAPI é gerado do código do gateway: alterar uma rota altera a referência na mesma entrega. Uma cópia manual em Markdown não tem esse vínculo — ela envelhece em silêncio e, num certo dia, passa a mentir. Documentação que mente é pior que documentação que falta.
Não existe arquivo de spec
Não há um openapi.yaml no repositório. A especificação é montada em tempo de execução a partir dos
schemas das rotas. Se você quiser o arquivo:
curl -s https://api.conota.dev/docs/json -o openapi-conota.json
Também disponível em YAML, em /docs/yaml.