Création d'un projet de code chaîne avec l'extension de code VS Blockchain App Builder

Pour créer un projet de code chaîne lors de l'utilisation du générateur d'applications Blockchain, vous devez utiliser un projet de code chaîne à partir d'un fichier de spécification détaillé. Cela génère un projet avec tous les fichiers dont vous avez besoin.

Contexte

Blockchain App Builder initialise et met à votre disposition un projet de code chaîne prêt à l'emploi. Sur la base d'une entrée simple, Créer un nouveau code chaîne peut générer des projets de code chaîne complexes avec des fonctionnalités telles que :

Plusieurs ressources (modèles) et leurs comportements (contrôleurs)
Générer automatiquement des méthodes CRUD (création/lecture/mise à jour/suppression) et non CRUD
Validation automatique des arguments
Marquage/désérialisation des arguments
Capacité de persistance transparente (ORM)
Appeler des requêtes enrichies
Prise en charge des données transitoires et privées
Gestion des identités

Le projet généré suit le modèle/contrôleur et le modèle de décorateur, ce qui permet de spécifier les propriétés d'une ressource maintenues dans le livre en tant que champs saisis et de les étendre avec des comportements et des règles de validation spécifiques. Cela réduit le nombre de lignes de code, ce qui facilite la lisibilité et l'évolutivité.

Créer un fichier de spécification

Avant de commencer, vous devez créer un fichier de spécification d'entrée. Notez que vous ne pouvez pas modifier les exemples de fichiers de spécification installés dans Blockchain App Builder, mais vous pouvez les dupliquer ou les utiliser comme fichier de référence pour vos propres fichiers de spécification.

Dans le panneau Spécifications, sélectionnez Créer un fichier de spécifications.
Le panneau Détails des spécifications s'ouvre :
- Entrez le nom du fichier de spécification.
- Sélectionnez le type de fichier - YAML et JSON sont pris en charge.
- Saisissez éventuellement une description pour le fichier.
- La liste déroulante Fichier de référence vous permet de générer votre fichier de spécification à partir d'un fichier préexistant dans votre espace de travail si vous disposez d'un fichier que vous souhaitez utiliser comme modèle. Si rien n'est sélectionné, le fichier créé sera vide et vous pourrez entrer votre spécification à partir de zéro.
- Saisissez l'emplacement de stockage du fichier de spécification sur votre système.
Cliquez sur Enregistrer.

Le nouveau fichier de spécification est créé et apparaît dans le panneau Spécifications. Cliquez dessus pour l'ouvrir dans l'éditeur.

Importer un fichier de spécification

Si vous disposez d'un fichier de spécification préexistant, vous pouvez l'importer :

Dans le panneau Spécifications, cliquez sur Actions supplémentaires et sélectionnez Importer la spécification.
Accédez à votre fichier et cliquez sur Importer la spécification.

Le fichier de spécification est importé et apparaît dans le panneau Spécifications. Cliquez dessus pour l'ouvrir dans l'éditeur.

Dupliquer un fichier de spécification

Vous pouvez également dupliquer un fichier de spécification qui figure déjà dans le panneau Spécifications en cliquant dessus avec le bouton droit de la souris et en sélectionnant Dupliquer. Cliquez avec le bouton droit de la souris sur le fichier et sélectionnez Renommer pour mettre à jour le nom.

Les détails relatifs au contenu des fichiers de spécifications sont décrits ici : Fichier de spécification d'entrée. Utilisez ces informations et les exemples de modèle de spécification pour créer le contenu de la spécification.

Validation d'un fichier de spécification

Si vous avez installé l'extension YAML Language Support, le fichier de spécification est automatiquement validé lors de la saisie. Les fonctionnalités de validation suivantes sont automatiquement prises en charge :

Exécution de la commande
Finalisation des noeuds scalaires par les valeurs par défaut du schéma
Aide contextuelle lorsque vous survolez une propriété ou une méthode
Indentation des éléments de tableau lors de la saisie
Détection des erreurs de syntaxe

Projet d'échafaudage de code chaîne

Lorsque vous disposez d'un fichier de spécification qui répond à vos besoins, générez votre projet de code chaîne.

Dans le panneau Codes chaîne, sélectionnez Créer un nouveau code chaîne.
Le panneau Détails du code chaîne s'ouvre :
- Saisissez le nom de votre projet de code chaîne.
- Sélectionnez la langue : TypeScript ou Go.
- Sélectionnez le fichier de spécification que vous utilisez pour créer le code chaîne.
- Entrez l'emplacement ou le domaine d'accès où vous souhaitez que le projet soit créé dans votre environnement de développement local.
Cliquez sur Créer.

Une fois le projet créé, il apparaît dans le panneau Codes chaîne. Tous les fichiers requis par le code chaîne figurent dans le projet. Pour obtenir un aperçu détaillé des fichiers créés, reportez-vous aux sections suivantes :

Pour une présentation détaillée d'un projet basé sur un jeton, reportez-vous également aux sections suivantes :

Remarques :

Le panneau Codes chaîne vous permet d'ouvrir et d'utiliser du contenu dans le projet de code chaîne, mais ne vous permet pas d'ajouter, de supprimer ou de renommer des fichiers dans le projet. Pour ce faire, cliquez avec le bouton droit de la souris sur votre projet et sélectionnez Ouvrir dans l'explorateur. Le projet s'ouvre dans la vue VS Code Explorer.
La suppression ou le changement de nom de fichiers dans le projet de code chaîne peut potentiellement rompre le lien entre les fichiers de projet et le fichier de spécification utilisé pour le créer. Si vous prévoyez de synchroniser votre code entre les deux, ne modifiez pas les noms de fichier.

Importer un projet de code chaîne existant

Si vous avez créé un projet de code chaîne via l'interface de ligne de commande ou que vous avez nettoyé le contenu de la chaîne de blocs VS Code et que vous souhaitez importer un projet enregistré localement, dans le panneau Codes chaîne, cliquez sur l'icône Plus d'actions... et sélectionnez Importer le code chaîne. Accédez au projet et cliquez sur Importer le code chaîne.