Spécification OpenAPI

Description lisible par machine de l'API REST CleverUtils. Utilisez-la pour générer des SDK clients, alimenter des clients d'API comme Postman ou Insomnia, ou explorer les points de terminaison de manière interactive dans Swagger UI.

Télécharger la spécification

La spécification OpenAPI 3.1 se trouve à :

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

Vous pouvez la télécharger directement avec cURL :

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

Générer un SDK client

Utilisez openapi-generator pour créer un client typé dans n'importe quel langage. Exemples :

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

Importer dans Postman / Insomnia

Swagger UI interactif

Explorez et testez les points de terminaison directement dans votre navigateur :

Swagger UI est chargé à la demande. Cliquez sur le bouton ci-dessous pour afficher l'explorateur d'API interactif. Nous ne le chargeons pas automatiquement afin de garder cette page légère.

Couverture de la spécification

La spécification OpenAPI décrit :

Versionnement

La spécification est versionnée en même temps que l'API. Les changements non rétrocompatibles seront publiés dans un nouveau /api/v2/openapi.json avec au moins 6 mois de préavis. Les changements rétrocompatibles (nouveaux points de terminaison, nouveaux champs optionnels) sont intégrés à v1 immédiatement.

Voir aussi :

Demander une fonctionnalité

0 / 2000