Récupérer une définition d'API pour Azure API Management - Cloud

Exemples d'utilisation de Talend Cloud API Designer
Version
Cloud
Language
Français
Product
Talend Cloud
Module
Talend API Designer
Content
Création et développement > Création d'APIs
Last publication date
2024-03-06

Exportez une définition d'API au format JSON compatible avec Azure API Management depuis Talend Cloud API Designer.

Avant de commencer

  • Vous avez installé cURL. Pour plus d'informations, consultez la documentation de cURL.
  • Vous avez généré un jeton d'accès personnel depuis Talend Cloud. Pour plus d'informations, consultez Générer un jeton d'accès personnel.
  • Vous avez créé une API dans Talend Cloud API Designer.

Procédure

  1. Ouvrez une invite de commande et entrez la commande suivante afin d'exporter votre définition d'API. 
    curl --header "Authorization:Bearer {userToken}" -X GET -o {outFile}.json https://apid.{region}.cloud.talend.com/api/v1/api-definitions/{api-id}?format=Swagger20Azure
  2. Ajoutez les paramètres adéquats :
    Paramètre Description
    {userToken} Jeton généré depuis Talend Cloud.
    {outFile} Chemin d'accès et nom du fichier de votre définition d'API. Par exemple : contactsapi.json.
    {region} Région de votre compte Talend Cloud. La valeur peut être :
    • us-west
    • us
    • eu
    • ap
    • au

    Pour plus d'informations, consultez URL et régions de Talend Cloud.
    {api-id} ID de la version de l'API à récupérer. Pour le récupérer, ouvrez votre API dans Talend Cloud API Designer et allez dans Settings > MANAGEMENT API ou utilisez la méthode GET sur l'endpoint /api-definitions pour obtenir une liste de définitions d'API avec leur ID.
  3. Exécutez la commande.

Résultats

Votre définition d'API est exportée au format JSON compatible avec Azure API Management et sauvegardée dans le répertoire sélectionné.

Pour plus d'informations concernant l'export d'une définition d'API avec un mode de compatibilité API Gateway, consultez le Guide d'utilisation de Talend Cloud API Designer.