Lib client

Clients disponibles

Les SDK maintenus par nos équipes sont disponibles en open-source sur notre compte github :

Spécification OpenAPI 3

Notre API fournit une spécification au format OpenAPI 3. Cette spécification standardisée permet de tirer partie des outils https://openapi.tools pour générer un client pour chaque language. Nous verrons dans cette documentation comment utiliser openapi-generator pour générer une lib client.

Dans cette page de documentation, nous utiliserons openapi-generator à travers l'image docker officielle pour simplifier les commandes d'installation. Vous pouvez vous référer à la documentation officielle de l'outil si vous souhaitez aller plus loin : https://openapi-generator.tech/

Récupérer la spécification OpenAPI 2 (anciennement swagger)

Plus d'infos sur OpenAPI 3 : https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md

wget -O ${PWD}/api/api-spec.json ${API_URL}/rest-json

Générer un client (exemple pour un client TS)

Pour générer un client similaire au notre, utilisez openapitools/openapi-generator-cli :

docker run --rm -v ${PWD}/src/api:/local openapitools/openapi-generator-cli generate \
    -i /local/api-spec.json \
    -g typescript-fetch \
    --additional-properties modelPropertyNaming=original

Liste des générateurs disponibles

Open API codegen permet de générer des clients dans de multiples languages. Veuillez vous référer à la documentation de votre language avant d'aller plus loin: https://openapi-generator.tech/docs/generators.html

Documentation par générateur

Pour afficher les options d'un générateur en particulier, utilisez la commande suivante :

# documentation of the typescript-node generator
docker run --rm -v ${PWD}/src/api:/local openapitools/openapi-generator-cli config-help -g typescript-node