Générer une spécification d'API Wrapper et une collection Postman

Vous pouvez utiliser Blockchain App Builder pour créer des fichiers filtrés de spécification d'adresse de compte/d'identité et une collection Postman correspondante.

Vérifiez que le fichier package.json inclut hardhat-plugin-obp-besu-wrapper-api et que la configuration Hardhat l'importe. Sélectionnez un package de jetons généré avec un manifeste et des artefacts de jeton/compte compilés. L'outil détecte les packages composés à partir de leur manifeste généré et prend également en charge les manifestes de projet de référence importés compatibles. Il ne déploie ni ne démarre un service d'API de wrapper. Le service API de wrapper est déjà exécuté dans le cadre de la configuration de l'instance.

  1. Générer des spécifications de jeton et de compte.
    1. Ouvrez Outils de développement et sélectionnez Générer une spécification d'API de wrapper et une collection Postman.
    2. Dans Configuration, sélectionnez le projet Hardhat, le package de jetons et un dossier de sortie dans le projet.
    3. Dans Mise en correspondance, passez en revue les API de jeton et les API de compte/d'identité. Conservez l'option Générer des API de wrapper sélectionnée pour chaque méthode qui restera dans la spécification d'adresse. Modifiez le chemin d'adresse si nécessaire.
    4. Sélectionnez Générer pour écrire les fichiers JSON de spécification de compte et de jeton filtrés, ainsi que la collection Postman.
  2. Ajoutez des adresses ORDS Swagger/OpenAPI.
    1. Dans la vue Mise en correspondance, sélectionnez l'API ORDS. L'outil prend en charge l'entrée d'API ORDS uniquement.
    2. Sélectionnez un fichier JSON ORDS Swagger/OpenAPI.
    3. Générez à nouveau les ressources de wrapper.
  3. Créez une API combinée, qui définit un workflow séquentiel qui combine les méthodes de jeton ou de compte sélectionnées en une seule adresse d'API de wrapper.
    1. Dans Mise en correspondance, sélectionnez Utiliser dans l'API combinée pour chaque méthode admissible.
    2. Sélectionnez Créer une API combinée.
    3. Entrez le nom d'API et le chemin d'adresse combinés.
    4. Vérifiez et réorganisez les étapes sélectionnées. Pour chaque étape, mappez ses champs source de charge utile de demande.
    5. Enregistrez le brouillon d'API combiné, puis sélectionnez Générer.
  4. Inscrire des spécifications auprès d'un service API de wrapper.
    1. Assurez-vous qu'un service API de wrapper est en cours d'exécution et sélectionnez l'onglet Déployer.
    2. Sélectionnez une spécification de jeton générée, une spécification de compte, les deux spécifications ou fournissez un corps JSON personnalisé.
    3. Entrez l'URL d'hôte de l'API de wrapper.
    4. Sélectionnez un environnement Oracle Blockchain Platform Besu afin que la demande puisse réutiliser ses paramètres d'authentification et TLS.
    5. Vérifiez l'aperçu de l'enregistrement et enregistrez les spécifications sélectionnées.

Publication d'inscription sur l'adresse /register du service d'API de wrapper. L'outil peut utiliser le chemin d'autorité de certification privé d'un environnement Oracle Blockchain Platform sélectionné ou un paramètre explicite auto-signé pour la demande d'inscription. Il ne déploie pas le service lui-même.

Dépannage

Condition Résolution
Des artefacts ou un manifeste sont manquants Compilez le projet sélectionné et vérifiez que les fichiers de package générés/importés existent.
Aucune adresse n'est générée Sélectionnez au moins une méthode pour la génération d'API de wrapper ou enregistrez au moins une API combinée valide.
Echec de la génération ORDS Fournissez un fichier JSON ORDS Swagger/OpenAPI et vérifiez que le module d'extension de projet prend en charge l'option --ords-swagger. Examinez le journal complet du module d'extension pour détecter les erreurs de schéma ou d'opération.
L'API combinée est rejetée Vérifiez le nom/chemin d'API, les étapes ordonnées et les mappages de champ de demande, puis enregistrez à nouveau le brouillon.
L'inscription n'est pas disponible Générez d'abord des fichiers de spécification d'adresse, puis sélectionnez un environnement Oracle Blockchain Platform Besu et fournissez une URL d'hôte d'API de wrapper accessible.