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.

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

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.
Cliquez sur le bouton près de la version que vous souhaitez copier et cliquez sur Create a new version from (Créer une nouvelle version depuis) <version>.
Saisissez la nouvelle version dans le champ Version.
Cliquez sur Create (Créer).

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

Sur la page d'accueil, cliquez sur le bouton à côté de la version à supprimer, puis sur Delete (Supprimer).

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.
Cliquez sur Delete (Supprimer) pour confirmer.

Résultats

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

Importer le contenu d'une version

Importez le contenu d'un contrat existant dans une version d'API, en remplaçant ou en fusionnant son contenu actuel.

Avant de commencer

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

Pourquoi et quand exécuter cette tâche

Utilisez cette fonctionnalité pour mettre à jour une version à partir d'un fichier de contrat d'API sans créer de nouvelle version. L'identificateur de version est conservé tout au long de l'importation.

Cette opération est différente de l'opération Importing a definition (Importer une définition), qui crée une nouvelle API dans Talend Cloud API Designer.

Procédure

Ouvrez Import version content (Importer le contenu de la version) de la version à mettre à jour.
Vous pouvez accéder à cette action depuis les emplacements suivants :
- Sur la page d'accueil, cliquez sur le bouton de menu à côté de la version, puis sur Import version content (Importer le contenu de la version).
- Sur la page d'accueil, sélectionnez la version pour ouvrir le volet de détails, puis cliquez sur Import version content (Importer le contenu de la version).
- Dans l'éditeur de version, cliquez sur Edit (Modifier) > Import version content (Importer le contenu de la version).
Sélectionnez un format et une source pour le contrat à importer.
Vous pouvez procéder à l'importation depuis un fichier local, une URL ou un texte que vous collez directement dans la boîte de dialogue.
Sous Behavior (Comportement), sélectionnez le mode d'application du contenu importé.
- Replace (Remplacer) : remplace l'ensemble du contenu actuel par le contrat importé. Le nom d'API, l'identificateur de version et la version de spécification sont conservés.
- Merge (Fusionner) : combine le contenu importé avec le contenu de version existant. Le nom d'API et l'identificateur sont conservés. Si un élément importé porte le même nom qu'un élément existant, l'élément importé est renommé avec un suffixe _merge (par exemple, User_merge). Les URL de base et les types de médias en double sont ignorés.
Cliquez sur Import (Importer).

Résultats

L'éditeur de version s'ouvre avec le contenu mis à jour appliqué.

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