Skip to main content
A Bunni Pay expoe o contrato OpenAPI gerado a partir dos controllers e DTOs da API. Esse documento e a unica fonte da verdade sobre metodos, parametros, corpos e respostas, e pode ser usado para gerar clientes, stubs de teste ou validacao automatica.

Como acessar

Os dois formatos estao disponiveis na raiz do dominio, sem autenticacao:
Nao ha prefixo /api. Em ambiente local, use http://localhost:4000.

Para que usar

O contrato OpenAPI contem todas as rotas publicas, seus parametros de query e header, corpos de request e esquemas de resposta. Voce pode usar esse arquivo com ferramentas como:
  • Geradores de cliente HTTP, como openapi-generator-cli ou swagger-codegen
  • Validadores de schema, como ajv ou zod
  • Documentacao automatica de consumers internos
O arquivo OpenAPI e servido diretamente pelo Swagger; ele nao inclui as rotas de health, public-metrics e outras auxiliares que estao fora do contrato gerado.