Especificación OpenAPI

Descripción legible por máquina de la API REST de CleverUtils. Úsala para generar SDK de cliente, cargar clientes de API como Postman o Insomnia, o explorar los endpoints de forma interactiva en Swagger UI.

Descargar la especificación

La especificación OpenAPI 3.1 se encuentra en:

URL
https://cleverutils.com/api/v1/openapi.json

Puedes descargarla directamente con cURL:

cURL
curl -O https://cleverutils.com/api/v1/openapi.json

Generar un SDK de cliente

Usa openapi-generator para crear un cliente tipado en cualquier lenguaje. Ejemplos:

Cliente Python
openapi-generator-cli generate \
  -i https://cleverutils.com/api/v1/openapi.json \
  -g python \
  -o ./cleverutils-python-client
Cliente TypeScript
openapi-generator-cli generate \
  -i https://cleverutils.com/api/v1/openapi.json \
  -g typescript-fetch \
  -o ./cleverutils-ts-client
Cliente Go
openapi-generator-cli generate \
  -i https://cleverutils.com/api/v1/openapi.json \
  -g go \
  -o ./cleverutils-go-client

Importar en Postman / Insomnia

Swagger UI interactivo

Explora y prueba los endpoints directamente en tu navegador:

Swagger UI se carga bajo demanda. Haz clic en el botón de abajo para mostrar el explorador de API interactivo. No lo cargamos automáticamente para mantener esta página ligera.

Cobertura de la especificación

La especificación OpenAPI describe:

Versionado

La especificación se versiona junto con la API. Los cambios incompatibles irán en un nuevo /api/v2/openapi.json con al menos 6 meses de aviso. Los cambios retrocompatibles (nuevos endpoints, nuevos campos opcionales) se incorporan a v1 de inmediato.

Véase también:

Solicitar una función

0 / 2000