Synchroniser les modifications du fichier de spécification avec le code source généré

Vous pouvez utiliser la fonction de synchronisation pour apporter de nouvelles modifications du fichier de spécification aux fichiers sources de code de chaîne (modèle et contrôleur). La fonction fonctionne avec les projets TypeScript et Go.

Note :
  • La synchronisation est unidirectionnelle : vous pouvez apporter des modifications de votre fichier de spécification dans votre projet de code de chaîne, mais pas dans l'autre sens. Les modifications apportées au projet de code de chaîne restent telles quelles après le processus de synchronisation.
  • La commande ne fonctionne que si le projet de code de chaîne a été échafaudé à l'aide d'un fichier de spécification. Ne supprimez pas, ne renommez pas ou ne déplacez pas le fichier de spécification si vous prévoyez de synchroniser les modifications du fichier de spécification au code source à l'avenir.
  • Lors de la synchronisation, les fichiers de code de chaîne du dossier lib sont automatiquement mis à niveau. Si vous apportez des modifications à ces fichiers de bibliothèque, sauvegardez les fichiers modifiés ou suivez les modifications que vous effectuez avant d'utiliser la fonction de synchronisation, afin de pouvoir appliquer ces modifications à nouveau après la synchronisation.
Pour synchroniser vos fichiers de spécification et de code de chaîne :
  1. Dans le volet Spécifications, sélectionnez le fichier de spécification que vous avez mis à jour pour ouvrir son volet Détails de la spécification. En haut du volet, cliquez sur Code de chaîne pour ouvrir le volet indiquant les codes de chaîne générés à partir du fichier de spécification.
  2. Cochez la case Synchroniser à côté de chaque code de chaîne à mettre à jour avec les nouvelles modifications. Vous pouvez synchroniser plusieurs codes de chaîne générés à partir d'un fichier de spécification à la fois. Cliquez sur Sélectionner.
Les projets de code de chaîne contiennent désormais des fichiers mis à jour.

Résolution des conflits

Comme vous pouvez modifier à la fois les fichiers de synchronisation et les fichiers de code de chaîne, il est possible de se retrouver avec des conflits où le fichier de spécification mis à jour pourrait remplacer une modification que vous avez apportée au fichier de code de chaîne. Dans ces cas, lorsque vous tentez de synchroniser une erreur s'affiche, indiquant qu'il y a un conflit. Vous pouvez utiliser le volet Conflits pour résoudre ces erreurs.

  1. Dans le volet Conflits, cliquez sur le nom du fichier de code de chaîne dans lequel les conflits existent. Le fichier s'ouvre dans un éditeur avec les conflits mis en surbrillance.
    Conflit de synchronisation affiché dans l'éditeur

    Dans l'exemple illustré, Marble124 se trouve dans le fichier de spécification et Marble123 se trouve dans le fichier de modèle de code de chaîne.

  2. Au-dessus du conflit se trouve une liste d'options. Cliquez sur Accepter la modification courante pour remplacer le fichier de spécification et utiliser ce qui se trouve actuellement dans le fichier de code de chaîne. Cliquez sur Accepter la modification entrante pour remplacer le fichier de code de chaîne et utiliser ce qui se trouve actuellement dans le fichier de spécification.
  3. Retournez au volet Conflits. Cochez la case Synchroniser à côté du nom du conflit, puis cliquez sur Confirmer les modifications. Si vous avez plusieurs conflits, résolvez-les avant de cliquer sur Confirmer les modifications.