Accéder au contenu principal Passer au contenu complémentaire

Configurer votre portail avec un autre fournisseur Git

Pour utiliser la fonctionnalité API Portal avec un fournisseur Git différent de GitHub, vous pouvez télécharger le kit de démarrage (Starter Kit) et votre documentation d'API, puis effectuer un push de ceux-ci dans votre dépôt.

Télécharger le kit de démarrage d'API Portal (Starter Kit)

Téléchargez le kit de démarrage d'API Portal depuis Talend Cloud pour l'utiliser avec votre fournisseur Git favori. Pour plus d'informations concernant le contenu du modèle, consultez Architecture du dépôt.

Procédure

  1. Connectez-vous à Talend Cloud.
  2. Cliquez sur le menu en haut à droite de la page et cliquez sur Téléchargements, puis faites défiler jusqu'à la tuile API Portal.
  3. Sélectionnez API Portal Starter Kit (zip) (Kit de démarrage d'API Portal (zip), puis cliquez sur Télécharger et sauvegardez le fichier.
    Tuile API Portal de la page Downloads (Téléchargements).
  4. Dézippez le fichier dans le dépôt à utiliser comme source de votre portail.
  5. Effectuez un commit de vos modifications.

Résultats

Votre dépôt est configuré, vous pouvez ajouter votre documentation d'API et personnaliser votre portail. Pour plus d'informations, consultez Personnaliser votre portail.

Télécharger votre documentation d'API

Téléchargez la documentation et les définitions d'API à publier sur votre portail.

Procédure

  1. Ouvrez Talend Cloud API Designer et allez dans l'onglet API Portal.
  2. Cliquez sur Configure the API Portal.
  3. Cliquez sur Select API Documentation to publish.
    Page de configuration d'API Portal.
  4. Dans l'onglet API Portal, cliquez sur le bouton Download (Téléchager) pour télécharger la documentation d'une API et sauvegarder le fichier.
    Par défaut, le fichier ZIP téléchargé contient :
    • Un fichier index.md contenant la documentation de l'API à publier sur le portail.
    • Un fichier openapi30.json et un fichier swagger20.json contenant la définition de l'API en OAS 3.0 et Swagger 2.0 respectivement. Ces fichiers peuvent être téléchargés par les utilisateur·trices depuis le portail.

    Vous pouvez sélectionner les définitions d'API à télécharger dans Settings (Paramètres). Pour plus d'informations, consultez Publier des définitions d'API téléchargeables.

    Onglet API Portal.
  5. Dézippez le fichier dans votre depôt, dans le dossier apis.
    Dans le dossier apis, vous devez avoir un dossier pour chaque API et un sous-dossier pour chaque version d'API.
  6. Effectuez un commit de vos modifications.

Résultats

Vous avez effectué un push d'une API dans votre dépôt, vous pouvez à présent déployer votre portail.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.