OpenAPI y SDKs

Genera SDKs o importa la API en Postman e Insomnia

CBCTHub publica una especificación OpenAPI 3.1 completa de la API v1. Sirve como contrato técnico oficial y te permite generar SDKs automáticos, importar la API en Postman/Insomnia y construir clientes type-safe en cualquier lenguaje.

URL del spec

La especificación se sirve como JSON estático desde el CDN, con CORS abierto y caché de 5 minutos. Es la fuente de verdad — refleja exactamente lo que la API responde en producción.

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

Importar en Postman / Insomnia / Bruno

  • PostmanPostman: File → Import → Link → pega la URL del spec. Cada endpoint queda como request en una colección "CBCTHub API".
  • InsomniaInsomnia: Application → Preferences → Data → Import Data → From URL. Insomnia auto-detecta OpenAPI 3.1 y genera el workspace.
  • BrunoBruno: importa el spec como colección desde File → Import → OpenAPI v3.

Generar un SDK

Usa openapi-generator-cli para crear un cliente HTTP completo en el lenguaje que prefieras. El comando descarga el spec, genera el código y lo deja en ./cbcthub-sdk.

bash
# 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

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

TypeScript: openapi-typescript (sin runtime)

Si solo necesitas los tipos (sin un cliente generado), openapi-typescript produce un único archivo .d.ts a partir del spec. Es la opción más ligera para proyectos Next.js o Deno.

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

Renderizar como documentación interactiva

El mismo spec se puede servir con Scalar, Redoc o Swagger UI dentro de tu sistema (útil si publicas una API propia construida encima de CBCTHub).

html
<!-- Scalar -->
<script id="api-reference" data-url="https://cbcthub.com/openapi.json"></script>
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
El spec se versiona junto con la API (campo info.version). Re-genera tu SDK cuando publiquemos una nueva versión para mantenerte al día.