Wrapper-API-Spezifikation und Postman-Sammlung generieren

Mit Blockchain App Builder können Sie gefilterte Token- und Account-/Identitätsendpunktspezifikationsdateien sowie eine übereinstimmende Postman-Sammlung erstellen.

Stellen Sie sicher, dass die Datei package.json hardhat-plugin-obp-besu-wrapper-api enthält und dass die Hardhat-Konfiguration sie importiert. Wählen Sie ein generiertes Tokenpackage mit einem Manifest und kompilierten Token-/Accountartefakten aus. Das Tool erkennt komponierte Pakete aus ihrem generierten Manifest und unterstützt auch kompatible importierte Referenzprojekt-Manifeste. Es wird kein Wrapper-API-Service bereitgestellt oder gestartet. Der Wrapper-API-Service wird bereits im Rahmen des Instanzsetups ausgeführt.

  1. Generieren Sie Token- und Kontospezifikationen.
    1. Öffnen Sie Entwicklungstools, und wählen Sie Wrapper-API-Spezifikation und Postman-Collection generieren aus.
    2. Wählen Sie unter Konfiguration das Hardhat-Projekt, das Tokenpackage und einen Ausgabeordner im Projekt aus.
    3. Prüfen Sie unter Zuordnung die Token-APIs und Account-/Identitäts-APIs. Lassen Sie Wrapper-APIs generieren für jede Methode ausgewählt, die in der Endpunktspezifikation verbleibt. Bearbeiten Sie gegebenenfalls den Endpunktpfad.
    4. Wählen Sie Generieren aus, um die gefilterten Token- und Kontospezifikations-JSON-Dateien sowie die Postman-Collection zu schreiben.
  2. Fügen Sie ORDS-Swagger-/OpenAPI-Endpunkte hinzu.
    1. Wählen Sie in der Ansicht Zuordnung die Option ORDS-API aus. Das Tool unterstützt nur ORDS-API-Eingaben.
    2. Wählen Sie eine ORDS-Swagger-/OpenAPI-JSON-Datei aus.
    3. Generieren Sie die Wrapper-Assets erneut.
  3. Erstellen Sie eine kombinierte API, die einen sequenziellen Workflow definiert, der ausgewählte Token- oder Accountmethoden in einem Wrapper-API-Endpunkt kombiniert.
    1. Wählen Sie unter Zuordnung für jede zulässige Methode die Option In kombinierter API verwenden aus.
    2. Wählen Sie Kombinierte API erstellen aus.
    3. Geben Sie den kombinierten API-Namen und Endpunktpfad ein.
    4. Prüfen Sie die ausgewählten Schritte, und ordnen Sie sie neu an. Ordnen Sie für jeden Schritt die Quellfelder für die Anforderungs-Payload zu.
    5. Speichern Sie den kombinierten API-Entwurf, und wählen Sie Generieren aus.
  4. Spezifikationen mit einem Wrapper-API-Service registrieren
    1. Stellen Sie sicher, dass ein Wrapper-API-Service ausgeführt wird, und wählen Sie die Registerkarte Bereitstellen aus.
    2. Wählen Sie eine generierte Tokenspezifikation, Kontospezifikation und beide Spezifikationen aus, oder geben Sie einen benutzerdefinierten JSON-Body an.
    3. Geben Sie die Wrapper-API-Host-URL ein.
    4. Wählen Sie eine Oracle Blockchain Platform Besu-Umgebung aus, damit die Anforderung ihre Authentifizierungs- und TLS-Einstellungen wiederverwenden kann.
    5. Prüfen Sie die Registrierungsvorschau, und registrieren Sie die ausgewählten Spezifikationen.

Registrierungsposts am /register-Endpunkt des Wrapper-API-Service. Das Tool kann den privaten CA-Pfad einer ausgewählten Oracle Blockchain Platform-Umgebung oder die explizite selbstsignierte Einstellung für die Registrierungsanforderung verwenden. Der Service selbst wird nicht bereitgestellt.

Fehlerbehebung

Bedingung Lösung
Artefakte oder Manifest fehlen Kompilieren Sie das ausgewählte Projekt, und bestätigen Sie, dass die generierten/importierten Paketdateien vorhanden sind.
Keine Endpunkte generiert Wählen Sie mindestens eine Methode für die Wrapper-API-Generierung aus, oder speichern Sie mindestens eine gültige kombinierte API.
ORDS-Generierung nicht erfolgreich Geben Sie eine ORDS-Swagger-/OpenAPI-JSON-Datei an, und bestätigen Sie, dass das Projekt-Plug-in die Option --ords-swagger unterstützt. Prüfen Sie das vollständige Plug-in-Log auf Schema- oder Vorgangsfehler.
Kombinierte API wurde abgelehnt Prüfen Sie den API-Namen/-Pfad, die geordneten Schritte und Anforderungsfeldzuordnungen, und speichern Sie den Entwurf erneut.
Registrierung ist nicht verfügbar Generieren Sie zuerst Endpunktspezifikationsdateien, wählen Sie dann eine Oracle Blockchain Platform Besu-Umgebung aus, und geben Sie eine erreichbare Wrapper-API-Host-URL an.