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

Configurer votre portail avec GitHub

Talend Cloud API Designer vous permet de configurer automatiquement un dépôt GitHub et de l'alimenter avec votre configuration de l'API Portal et votre documentation d'API. Si vous souhaitez utiliser un fournisseur de contrôle des versions, consultez Configurer votre portail avec un autre fournisseur Git.

Procédure

  1. Ouvrez Talend Cloud API Designer et allez dans l'onglet API Portal.
  2. Cliquez sur Configure the API Portal.
  3. Connectez votre dépôt GitHub :
    • Si vous n'avez pas associé de compte GitHub à Talend Cloud API Designer, cliquez sur Link your GitHub account et autorisez Talend à accéder à vos dépôts.
    • Si votre compte est déjà associé, cliquez sur Select a GitHub repository.
    Page de configuration d'API Portal.
  4. Sélectionnez le dépôt à utiliser :
    • Pour créer un dépôt, sélectionnez Create a new GitHub repository, sélectionnez le·a propriétaire et saisissez un nom.
    • Pour utiliser un dépôt existant, sélectionnez Use an existing GitHub repository, sélectionnez le·a propriétaire, le dépôt et la branche à utiliser.
    Boîte de dialogue Select a GitHub repository (Sélectionner un dépôt GitHub).
  5. Facultatif : Cliquez sur le bouton Enable GitHub Pages (Activer GitHub Pages) et donnez au workflow GitHub le droit de publier automatiquement votre portail dans GitHub Pages.
    Cette autorisation est nécessaire pour configurer automatiquement GitHub Actions sur votre dépôt. Vous pouvez également activer GitHub Pages ultérieurement depuis les paramètres d'API Portal ou manuellement depuis votre dépôt. Pour plus d'informations, consultez Déployer votre portail avec GitHub Pages.
    Note InformationsRemarque : Cela écrase toute configuration de GitHub Pages existant sur votre dépôt.
  6. Cliquez sur Select API Documentation to publish.
    Un commit du modèle d'API Portal est effectué sur le dépôt sélectionné, sur la branche sélectionnée, si vous utilisez un dépôt existant ou sur la branche principale main si vous en créez un nouveau. La liste des API publiables s'affiche.
  7. Cliquez sur le bouton Publish près de l'API à publier.
    Capture d'écran de la liste des API non publiées.

Résultats

Le dépôt de votre API Portal est configuré et votre première API est publiée. Vous pouvez personnaliser et déployer votre portail.

Dans cette section

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.

Laissez vos commentaires ici