Utilisez la méthode POST
sur l'endpoint /api-definitions
pour importer une définition d'API dans Talend Cloud API Designer.
Avant de commencer
Procédure
- Ouvrez Talend Cloud API Tester et créez une requête.
- Dans la liste déroulante METHOD, sélectionnez POST.
-
Saisissez l'URI ci-dessous en utilisant le paramètre de région approprié :
https://apid.{region}.cloud.talend.com/api/v1/api-definitions
La région peut être :-
us-west
-
us
-
eu
-
ap
-
au
Pour plus d'informations, consultez URL et régions de Talend Cloud.
-
- Facultatif :
Développez QUERY PARAMETERS et cliquez sur Add query parameters.
Les paramètres disponibles sont les suivants :
Paramètre Description format
Format de la définition d'API à importer. La valeur peut être : - OpenApi3 (valeur par défaut)
- Swagger20
- Swagger12
- Raml10
- Raml08
failOnWarnings
Indique si vous souhaitez arréter le processus au premier avertissement sur la transformation du modèle. Sa valeur peut être true ou false. La valeur par défaut est false. mainFile
Si vous importer une définition d'API contenant plusieurs fichier dans une même archive, saisissez le nom du fichier de définition principal. -
Cliquez sur le bouton Add header, saisissez Authorization dans le champ name et Bearer suivi d'un espace, puis de votre jeton, dans le champ value.
Conseil : Dans Talend Cloud API Tester, vous pouvez ajouter votre jeton comme variable d'environnement privée et y faire référence dans vos requêtes, à l'aide de l'Expression Builder. Pour plus d'informations, consultez Utiliser des environnements.
- Facultatif :
Modifiez l'en-tête
Content-Type
.Par défaut, Talend Cloud API Tester ajoute un en-têteContent-Type
contenant la valeurapplication/json
des requêtesPOST
. Si vous voulez importer vôtre définition en tant que fichier YAML ou .zip, modifier cette valeur en application/x-yaml ou enapplication/zip
. -
Ajoutez vôtre définition d'API :
- Saisissez la définition dans la zone de texte BODY.
- Cliquez sur la liste déroulante Text située au dessus du corps de la requête et sélectionnez File. Parcourez ensuite le système jusqu'au fichier, ou effectuez un glisser-déposer.
- Saisissez la définition dans la zone de texte BODY.
- Une fois votre requête configurée, cliquez sur Send.