OpenAPI e SDKs

O CBCTHub publica uma especificação OpenAPI 3.1 completa da API v1. Funciona como contrato técnico oficial e permite gerar SDKs automáticos, importar a API no Postman/Insomnia e construir clientes type-safe em qualquer linguagem.

URL do spec

O spec é servido como JSON estático pela CDN, com CORS aberto e cache de 5 minutos. É a fonte de verdade — reflete exatamente o que a API responde em produção.

GET https://cbcthub.com/openapi.json

Importar no Postman / Insomnia / Bruno

• Postman — Postman: File → Import → Link → cole a URL do spec. Cada endpoint vira uma request na coleção "CBCTHub API".
• Insomnia — Insomnia: Application → Preferences → Data → Import Data → From URL. O Insomnia detecta OpenAPI 3.1 automaticamente e cria o workspace.
• Bruno — Bruno: importe o spec como coleção em File → Import → OpenAPI v3.

Gerar um SDK

Use openapi-generator-cli para criar um cliente HTTP completo na linguagem que preferir. O comando baixa o spec, gera o código e o coloca em ./cbcthub-sdk.

# TypeScript (axios)
npx @openapitools/openapi-generator-cli generate \
  -i https://cbcthub.com/openapi.json \
  -g typescript-axios \
  -o ./cbcthub-sdk

# Python
npx @openapitools/openapi-generator-cli generate \
  -i https://cbcthub.com/openapi.json \
  -g python \
  -o ./cbcthub-sdk-python

# Go
npx @openapitools/openapi-generator-cli generate \
  -i https://cbcthub.com/openapi.json \
  -g go \
  -o ./cbcthub-sdk-go

# PHP
npx @openapitools/openapi-generator-cli generate \
  -i https://cbcthub.com/openapi.json \
  -g php \
  -o ./cbcthub-sdk-php

Geradores populares: typescript-axios, typescript-fetch, python, php, go, java, csharp, ruby, rust, kotlin, swift5.

TypeScript: openapi-typescript (sem runtime)

Se você só precisa dos tipos (sem cliente gerado), openapi-typescript produz um único arquivo .d.ts a partir do spec. É a opção mais leve para projetos Next.js ou Deno.

npx openapi-typescript https://cbcthub.com/openapi.json -o ./cbcthub-types.d.ts

Renderizar como documentação interativa

O mesmo spec pode ser servido com Scalar, Redoc ou Swagger UI dentro do seu sistema (útil se você publica uma API própria construída em cima do CBCTHub).

<!-- Scalar -->
<script id="api-reference" data-url="https://cbcthub.com/openapi.json"></script>
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>