Effectuer un Push d'une version d'API dans GitHub - Cloud

Guide 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-13
Liez votre API à un référentiel GitHub et effectuez un Push de votre définition d'API au format OAS/Swagger ou RAML.

Avant de commencer

  • Vous devez avoir un compte et un référentiel GitHub.
  • Votre navigateur doit être supporté par GitHub (comme Internet Explorer 11 n'est plus supporté par GitHub, cette fonctionnalité n'est pas supportée par Talend Cloud API Designer pour IE11).

Procédure

  1. Ouvrez la version de l'API sur laquelle effectuer un push dans GitHub et cliquez sur Settings.
  2. Si votre compte GitHub n'est pas lié à votre compte Talend Cloud API Designer, cliquez sur Link your GitHub account.
    Section GITHUB de la vue Settings (Paramètres) de l'API.
  3. Dans la fenêtre qui s'ouvre, connectez-vous à GitHub et cliquez sur Authorize Talend pour autoriser Talend Cloud API Designer à accéder à votre compte GitHub.
    Avertissement : Si vous utilisez Internet Explorer 11, il vous est demandé d'effectuer une mise à niveau vers la dernière version de Microsoft Edge, Google Chrome ou Firefox.

    Votre compte GitHub est à présent lié à votre compte Talend Cloud API Designer et vous pouvez commencer à effectuer des Push de définitions d'API dans GitHub.

  4. Dans les paramètres de votre API, utilisez les listes déroulantes afin de sélectionner les options Owner, Repository, Branch et Format, puis saisissez un chemin dans le champ Path et cliquez sur Save.
    Dans la liste déroulante Format, vous pouvez choisir d'exporter votre définition avec les extensions Talend ou avec le mode de compatibilité API Gateway.
    Paramètres d'exemple pour lier la définition d'API à un dépôt GitHub.
    Remarque : Si votre API a plusieurs versions, chaque version peut avoir différents paramètres GitHub.
  5. Une fois vos paramètres sauvegardés, cliquez sur Push.
    Un point vert s'affiche à droite de Push lorsque votre projet contient des modifications n'ayant pas été pushées dans GitHub.
    Capture d'écran du projet avec des modifications dont le push vers GitHub n'a pas été effectué.
  6. Saisissez un message de commit et un tag, si nécessaire, puis cliquez sur Push.
    Un tag doit être unique et doit suivre ces règles :
    • Il ne peut contenir que des caractères alphanumériques et les caractères spéciaux suivants : _, -, . et /.
    • Il ne peut commencer ou finir par un caractère spécial.
    • Il ne peut contenir les modèles de caractères suivants : .., // et /..

Résultats

La version sélectionnée de votre définition d'API est transférée (push) à votre dépôt. Le nom du fichier généré contient le nom et la version de l'API.

Vous pouvez cliquer sur View on GitHub pour ouvrir le dépôt sélectionné.