Documentation OpenAPI

La documentation complète de l'API Raisetalk est disponible au format OpenAPI à l'adresse suivante : https://api.raisetalk.com/docs.

Elle est générée automatiquement à partir du code source de l'API et mise à jour à chaque déploiement, ce qui garantit qu'elle reflète toujours fidèlement le comportement réel des endpoints exposés.

Le fichier de spécification brut est également accessible à l'adresse https://api.raisetalk.com/openapi.yaml.

Générer un SDK

À partir de cette spécification OpenAPI, il est facile de générer un SDK client dans à peu près n'importe quel langage (PHP, Python, TypeScript, Java, Go, Ruby, C#, etc.) via l'outil openapi-generator-cli.

Exemple pour générer un SDK PHP :

docker run --rm \
  -v "${PWD}:/local" \
  openapitools/openapi-generator-cli generate \
  -i https://api.raisetalk.com/openapi.yaml \
  -g php \
  -o /local/sdk/php

Pour changer de langage cible, il suffit de remplacer la valeur du paramètre -g (par exemple -g python, -g typescript-axios, -g java, etc.).

La liste complète des générateurs disponibles ainsi que la documentation détaillée de l'outil sont disponibles sur le site officiel : https://openapi-generator.tech/.