OpenAPI-specificatie

Machine-leesbare beschrijving van de CleverUtils REST API. Gebruik deze om client-SDK's te genereren, API-clients zoals Postman of Insomnia te vullen, of de endpoints interactief te verkennen in Swagger UI.

Download de specificatie

De OpenAPI 3.1-specificatie staat op:

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

Je kunt deze direct downloaden met cURL:

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

Een client-SDK genereren

Gebruik openapi-generator om een getypeerde client in elke taal op te zetten. Voorbeelden:

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

Importeren in Postman / Insomnia

Interactieve Swagger UI

Blader door en test endpoints direct in je browser:

Swagger UI wordt op aanvraag geladen. Klik op de knop hieronder om de interactieve API-verkenner te tonen. We laden deze niet automatisch om deze pagina lichtgewicht te houden.

Specificatie-dekking

De OpenAPI-specificatie beschrijft:

Versiebeheer

De specificatie heeft dezelfde versie als de API. Breaking changes komen in een nieuwe /api/v2/openapi.json met minstens 6 maanden aankondiging vooraf. Achterwaarts compatibele wijzigingen (nieuwe endpoints, nieuwe optionele velden) worden direct in v1 opgenomen.

Zie ook:

Functie aanvragen

0 / 2000