Referência OpenAPI interativa
O schema OpenAPI 3.1 completo, legível por máquina, é servido pela própria API em:
https://api.canverly.com/openapi.jsonO visualizador interativo abaixo é renderizado pelo Scalar, que busca o schema diretamente no carregamento da página. Todas as 22 operações podem ser navegadas e toda resposta está documentada.
O widget de autenticação envia as requisições para https://api.canverly.com — produção.
Qualquer chave que você colar ali age sobre o site real ao qual ela pertence, então um POST /v1/posts feito desta página publica de verdade. Chamadas de leitura são seguras; use um
rascunho descartável se quiser testar uma escrita.
Alternativas
Seção intitulada “Alternativas”Se o Scalar não carregar (ex.: CSP corporativa, leitura offline), tente estas opções:
- Schema bruto: https://api.canverly.com/openapi.json — encaminhe para qualquer ferramenta OpenAPI (Postman, Insomnia, openapi-generator).
- Stoplight Elements: cole a URL do schema em https://elements-demo.stoplight.io.
- Swagger Editor: https://editor.swagger.io → File → Import URL.
Estabilidade do schema
Seção intitulada “Estabilidade do schema”O schema OpenAPI é a fonte da verdade da superfície da API. Mudanças incompatíveis são versionadas pelo prefixo da URL (/v1, /v2, …) e anunciadas com pelo menos 90 dias de antecedência pelo changelog. Mudanças aditivas (novos campos opcionais, novos endpoints, novos membros de enum) saem sem aviso.