Wrapper-APIs mit Visual Studio Code generieren

Mit der erweiterten Version von Blockchain App Builder können Sie Wrapper-APIs in Visual Studio Code generieren.

Wenn Sie Wrapper-APIs in Visual Studio Code generieren, werden Sie aufgefordert, vorherige Wrapper-API-Packages zu überschreiben, die im Auswahlspeicherort vorhanden sind.

API Gateway begrenzt die Anzahl der Routen, die in einem einzelnen Deployment erstellt werden können, auf 50. Wenn Sie versuchen, mehr als 50 Wrapper-APIs zu generieren, werden Sie aufgefordert, mehrere Gateways zu erstellen. Wenn Sie mehrere Gateways mit demselben Deployment-Pfadpräfix erstellen, wird ein konsistenter Basispfad über alle Wrapper-API-Endpunkte hinweg beibehalten. Wenn Sie nicht mehrere Gateways erstellen, wird die Wrapper-API-Generierung abgebrochen. Sie können vorhandene Gateways auch wiederverwenden, wie in den folgenden Schritten beschrieben.

  1. Wählen Sie das Chaincode-Projekt im Bereich Chaincodes aus.
  2. Klicken Sie mit der rechten Maustaste auf den Chaincodenamen, und wählen Sie Wrapper-API-Package generieren aus. Der Fensterbereich Oracle Blockchain Platform - Wrapper-API-Packagegenerierung wird geöffnet.
  3. Geben Sie die Konfigurationsvariablen wie in der folgenden Tabelle beschrieben ein.
    Feld Beschreibung Standardwert
    Compartment-OCID Die OCID des Compartments in Oracle Cloud Infrastructure (OCI). Kein
    Compartment-Name Der Name des OCI Compartments. Kein
    Identitätsdomain Die zu verwendende Identitätsdomain. Kein
    Blockchain-Kanal Der Name des Oracle Blockchain Platform-Kanals, in dem der Chaincode bereitgestellt wird. Kein
    Blockchain-URL Die Oracle Blockchain Platform-URL, die mit dem Chaincode-Deployment verknüpft ist. Kein
    Ort Das Systemverzeichnis, in dem das Wrapper-API-Package generiert werden soll. Kein
    Neues API-Gateway Um API-Gateways zu erstellen, wählen Sie Ja aus, und geben Sie einen Gatewayanzeigenamen an. Um vorhandene API-Gateways wiederzuverwenden, wählen Sie Nein aus, und geben Sie dann ein Array von Oracle Cloud-IDs (OCIDs) an, damit vorhandene API-Gateways im folgenden Format wiederverwendet werden können. Sie müssen ein Gateway für jeweils 50 Wrapper-APIs angeben.
    ["ocid1.apigateway.xxx", "ocid1.apigateway.yyy"]
    Ja
    Deployment-Pfadpräfix Das Deployment-Pfadpräfix in API Gateway, das den Pfad angibt, in dem Routen bereitgestellt werden. Das Deployment-Pfadpräfix muss mit einem Schrägstrich (/) beginnen. /<ChaincodeName>
    Blockchainsynchronisierung Der Synchronisierungswert, der in die Payload für API-Aufrufe aufgenommen werden soll. True
    Blockchain-Timeout Der Timeoutwert, der in die Payload für API-Aufrufe aufgenommen werden soll. 6.000
    Policy-Name Der Name der Policy, die eine kontrollierte Verwaltung und Zugriff auf APIs über definierte Berechtigungen für Gruppen und Compartments in der Organisation ermöglicht ChaincodeName
    VCN-Anzeigename Der Anzeigename des virtuellen OCI-Cloud-Netzwerks. ChaincodeName
    Anwendungsanzeigename Der Anzeigename der OCI-Anwendung. ChaincodeName
    Gateway-Anzeigename Der Anzeigename des API-Gateways. ChaincodeName
    Deployment-Anzeigename Der Anzeigename des API-Gateways. ChaincodeName
    OCI Repo-Name Der Name des OCI Registry-Repositorys, der aus Kleinbuchstaben bestehen muss. ChaincodeName in Kleinbuchstaben
  4. Klicken Sie auf Speichern.
  5. Klicken Sie auf die Registerkarte Zuordnung. Im Bereich "Mapping" wird eine Tabelle aller Controller-APIs angezeigt, die im Chaincode verfügbar sind. Jede Methode verfügt über einen entsprechenden API-Endpunkt, den Sie nach Bedarf bearbeiten können. Aktivieren Sie das entsprechende Kontrollkästchen Wrapper-APIs generieren, um die Controller-API in das Wrapper-API-Package aufzunehmen. Klicken Sie auf Alle auswählen, um alle Controller-APIs einzuschließen.
  6. Klicken Sie auf Speichern.
  7. Klicken Sie auf Generieren. Das Wrapper-API-Package und die zugehörige Postman-Collection werden generiert.