Genera una specifica API wrapper e una raccolta postman

È possibile utilizzare Blockchain App Builder per creare file di specifica degli endpoint di token e account/identità filtrati e una raccolta Postman corrispondente.

Verificare che il file package.json includa hardhat-plugin-obp-besu-wrapper-api e che la configurazione Hardhat lo importi. Selezionare un package di token generato con un file manifesto e artifact di token/account compilati. Lo strumento rileva i pacchetti composti dal file manifesto generato e supporta anche file manifesto di riferimento importati compatibili. Non distribuisce o avvia un servizio API wrapper. Il servizio API wrapper è già eseguito nell'ambito dell'impostazione dell'istanza.

  1. Generare token e specifiche dell'account.
    1. Aprire Strumenti per sviluppatori e selezionare Genera specifica API wrapper e raccolta postman.
    2. In Configurazione selezionare il progetto Hardhat, il package di token e una cartella di output all'interno del progetto.
    3. In Mapping, esaminare le API token e le API account/identità. Mantenere selezionata l'opzione Genera API wrapper per ogni metodo che rimarrà nella specifica dell'endpoint. Modificare il percorso dell'endpoint, se necessario.
    4. Selezionare Genera per scrivere i file JSON di token e specifica conto filtrati e la raccolta Postman.
  2. Aggiungere gli endpoint Swagger/OpenAPI ORDS.
    1. Nella vista Mapping, selezionare API ORDS. Lo strumento supporta solo l'input dell'API ORDS.
    2. Selezionare un file JSON ORDS Swagger/OpenAPI.
    3. Generare di nuovo gli asset wrapper.
  3. Crea un'interfaccia API combinata che definisce un flusso di lavoro sequenziale che combina i metodi token o account selezionati in un unico endpoint API wrapper.
    1. In Mapping selezionare Usa in API combinata per ciascun metodo idoneo.
    2. Selezionare Crea API combinata.
    3. Immettere il nome API e il percorso endpoint combinati.
    4. Rivedere e riordinare i passi selezionati. Per ogni passo, mappare i relativi campi di origine richiesta-payload.
    5. Salvare la bozza dell'API combinata, quindi selezionare Genera.
  4. Registra le specifiche con un servizio API wrapper.
    1. Assicurarsi che sia in esecuzione un servizio API wrapper e selezionare la scheda Distribuisci.
    2. Selezionare una specifica di token generata, una specifica di account, entrambe le specifiche o fornire un corpo JSON personalizzato.
    3. Immettere l'URL host dell'API wrapper.
    4. Selezionare un ambiente Besu di Oracle Blockchain Platform in modo che la richiesta possa riutilizzare le impostazioni di autenticazione e TLS.
    5. Esaminare l'anteprima della registrazione e registrare le specifiche selezionate.

La registrazione viene inviata all'endpoint /register del servizio API wrapper. Lo strumento può utilizzare il percorso CA privato di un ambiente Oracle Blockchain Platform selezionato o un'impostazione autofirmata esplicita per la richiesta di registrazione. Non distribuisce il servizio stesso.

Risoluzione dei problemi

Condizione Risoluzione
Artifact o manifesto mancanti Compilare il progetto selezionato e confermare l'esistenza dei file di package generati/importati.
Nessun endpoint generato Selezionare almeno un metodo per la generazione dell'API wrapper oppure salvare almeno un'API combinata valida.
Generazione ORDS non riuscita Fornire un file JSON ORDS Swagger/OpenAPI e confermare che il plugin progetto supporti l'opzione --ords-swagger. Esaminare il log del plugin completo per individuare eventuali errori di schema o di operazione.
API combinata rifiutata Controllare il nome/percorso dell'API, i passi ordinati e i mapping dei campi di richiesta, quindi salvare di nuovo la bozza.
Registrazione non disponibile Generare prima i file delle specifiche degli endpoint, quindi selezionare un ambiente Besu di Oracle Blockchain Platform e fornire un URL host dell'API wrapper raggiungibile.