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

Utiliser plusieurs versions

Talend Cloud API Designer vous permet d'utiliser plusieurs versions de la même définition d'API pour vous permettre de gérer le cycle de vie de votre API. Vous pouvez :

  • Maintenir une version d'API existante en production tout en introduisant des modifications majeures dans une nouvelle version.
  • Gagner en visibilité et en contrôle sur vos versions publiées.
  • Gagner en flexibilité lors de modifications sur une API.

Lorsque vous créez une nouvelle version d'une API, tout le contenu est copié dans la nouvelle version. Chaque version peut ensuite être modifiée indépendamment sans affecter les autres.

La page d'accueil de Talend Cloud API Designer affiche toutes les API que vous possédez et toutes les versions d'API partagées avec vous.
Page d'accueil de Talend Cloud API Designer.

Créer une version d'API

Créez une nouvelle version d'une définition d'API existante.

Avant de commencer

Vous êtes propriétaire de l'API ou éditeur·trice d'une version de l'API.

Procédure

  1. Dans la page d'accueil, allez à l'API pour laquelle vous souhaitez créer une nouvelle version.
    Vous pouvez filtrer la liste par nom ou propriétaire, si besoin.
  2. Cliquez sur le bouton Menu près de la version que vous souhaitez copier et cliquez sur Create a new version from (Créer une nouvelle version depuis) <version>.
    Vue de l'API Movie (catalogue de films) et de l'icône de Menu développée pour la version 1.1.0.
  3. Saisissez la nouvelle version dans le champ Version.
  4. Facultatif : Décochez la case Copy sharing settings (Copier les paramètres de partage) afin de réinitialiser les paramètres de partage.
    Par défaut, si la version source est partagée avec d'autres personnes, les mêmes paramètres sont copiés dans la nouvelle version. Si vous décochez cette case, la nouvelle version hérite des paramètres de partage au niveau de l'API. Pour plus d'informations, consultez Partager une version spécifique d'une API.
  5. Facultatif : Modifiez vos paramètres GitHub.
    Par défaut, si la version source est liée à GitHub, les mêmes paramètres sont copiés dans la nouvelle version. Vous pouvez modifier la branche et le chemin d'accès ou vous pouvez décocher la case Copy GitHub settings (Copier les paramètres GitHub) pour désactiver l'intégration GitHub pour la nouvelle version. Vous pouvez ensuite l'activer et la configurer selon vos besoins. Pour plus d'informations, consultez Effectuer un Push d'une version d'API dans GitHub.
  6. Cliquez sur Create.
    Boîte de dialogue Create a new version (Créer une version) dans laquelle une version est créée à partir de la version 1.1.0 de l'API Movie. Sa nouvelle version est 1.2.0 et les options pour copier les paramètres de partage et de GitHub sont sélectionnées. La version est créée sur la branche main.

Résultats

Une nouvelle version de votre API est créée, avec le même contenu que dans la version source. Les mocks et la documentation sont désactivés par défaut.

Supprimer une version d'API

Avant de commencer

Vous êtes propriétaire de l'API.

Procédure

  1. Dans la page d'accueil, cliquez sur le bouton Menu près de la version à supprimer et cliquez sur Delete version (Supprimer la version).
    Note InformationsRemarque : Vous ne pouvez supprimer une version si sa documentation est publiée dans l'API Portal. Vous devez annuler sa publication ou la marquer comme non publiée avant de la supprimer. Pour plus d'informations, consultez Gérer votre documentation d'API.
  2. Cliquez sur Are you sure? afin de confirmer.

Résultats

La version sélectionnée est supprimée. Si vous souhaitez supprimer une API entière, vous devez supprimer chaque version.

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.