Récupérer votre documentation d'API avec l'API de gestion

Utilisez l'API de gestion de Talend Cloud API Designer pour récupérer votre définition d'API dans le format API Portal Content et l'ajouter à votre dépôt.

1. Utilisez la commande suivante avec les paramètres correspondants pour obtenir l'API au bon format :

   curl -X GET -H "Authorization:Bearer {userToken}" https://apid.{region}.cloud.talend.com/api/v1/api-definitions/{api-id}?format=ApiPortalContent

   Paramètre	Value (Valeur)
   {userToken}	Jeton généré depuis Talend Cloud.
   {region}	Région de votre compte Talend Cloud. La valeur peut être : us-west us eu ap au Pour plus d'informations, consultez Accéder aux applications 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.

2. Copiez la réponse dans la commande.
3. Dans le dépôt de votre API Portal, ouvrez le dossier apis.
4. Dans apis, créez un dossier avec le nom de votre API et, dans ce dossier, créez un dossier avec le nom de la version.

   Exemple

   Si vous avez une API nommée Contacts en version 4.0.0, la structure du dossier doit ressembler à ceci : /apis/contacts-api/4.0.0/.
5. Créez un fichier nommé index.md dans le dossier de version et collez la réponse dans la commande.

   Exemple

   

6. Facultatif : Si vous souhaitez également fournir des définitions d'API téléchargeables par vos utilisateur·trices, utilisez la même commande au format OpenApi3 ou Swagger20, puis sauvegardez le contenu de la réponse en tant que openapi30.json ou swagger20.json dans le même dossier que la documentation.
7. Effectuez un commit de vos modifications.