Spécification OpenAPI

L’API Service publie une description OpenAPI 3 lisible par une machine — la même spécification qui alimente la référence de l’API (en anglais). Utilisez-la pour générer un client/SDK typé, importer l’API dans Postman ou Insomnia, ou valider les requêtes et les réponses dans vos propres outils.

Télécharger

openapi.yaml — la spécification complète (YAML).

Elle décrit chaque point de terminaison, chaque paramètre de requête, chaque structure de réponse ainsi que l’enveloppe d’erreur, avec https://api.useservice.app comme serveur. La spécification reflète toujours la version actuelle de l’API ; les changements incompatibles sont livrés sous une nouvelle Service-Version datée.

Utilisations courantes

• Générer un SDK avec openapi-generator ou openapi-typescript, par exemple openapi-generator-cli generate -i https://docs.useservice.app/api/openapi.yaml -g <language>.
• Importer dans Postman / Insomnia pour explorer les points de terminaison et essayer des requêtes avec votre clé d’API.
• La parcourir au format rendu dans la référence de l’API (en anglais).