OpenAPI-Spezifikation

Maschinenlesbare Beschreibung der CleverUtils REST API. Verwenden Sie sie, um Client-SDKs zu generieren, API-Clients wie Postman oder Insomnia zu befüllen oder die Endpunkte interaktiv in Swagger UI zu durchsuchen.

Spezifikation herunterladen

Die OpenAPI 3.1-Spezifikation befindet sich unter:

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

Sie können sie direkt mit cURL herunterladen:

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

Client-SDK generieren

Verwenden Sie openapi-generator, um einen typisierten Client in einer beliebigen Sprache zu erstellen. Beispiele:

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

In Postman / Insomnia importieren

Interaktive Swagger UI

Durchsuchen und testen Sie Endpunkte direkt in Ihrem Browser:

Swagger UI wird bei Bedarf geladen. Klicken Sie auf die Schaltfläche unten, um den interaktiven API-Explorer anzuzeigen. Wir laden ihn nicht automatisch, um diese Seite leichtgewichtig zu halten.

Umfang der Spezifikation

Die OpenAPI-Spezifikation beschreibt:

Versionierung

Die Spezifikation wird zusammen mit der API versioniert. Breaking Changes erscheinen in einem neuen /api/v2/openapi.json mit mindestens 6 Monaten Vorlaufzeit. Abwärtskompatible Änderungen (neue Endpunkte, neue optionale Felder) werden sofort in v1 übernommen.

Siehe auch:

Funktion vorschlagen

0 / 2000