Generate a Wrapper API Specification and Postman Collection

You can use Blockchain App Builder to create filtered token and account/identity endpoint specification files and a matching Postman collection.

Confirm that the package.json file includes hardhat-plugin-obp-besu-wrapper-api and that the Hardhat configuration imports it. Select a generated token package with a manifest and compiled token/account artifacts. The tool discovers composed packages from their generated manifest and also supports compatible imported reference-project manifests. It does not deploy or start a wrapper API service. The wrapper API service is already run as part of instance setup.

1. Generate token and account specifications.
   1. Open Developer Tools and select Generate Wrapper API Specification and Postman Collection.
   2. In Configuration, select the Hardhat project, token package, and an output folder inside the project.
   3. In Mapping, review the token APIs and account/identity APIs. Keep Generate Wrapper APIs selected for each method that will remain in the endpoint specification. Edit the endpoint path where required.
   4. Select Generate to write the filtered token and account specification JSON files and the Postman collection.
2. Add ORDS Swagger/OpenAPI endpoints.
   1. In the Mapping view, selected ORDS API. The tool supports ORDS API input only.
   2. Select an ORDS Swagger/OpenAPI JSON file.
   3. Generate the wrapper assets again.
3. Create a combined API, which defines a sequential workflow that combines selected token or account methods into one wrapper API endpoint.
   1. In Mapping, select Use in Combined API for each eligible method.
   2. Select Create Combined API.
   3. Enter the combined API name and endpoint path.
   4. Review and reorder the selected steps. For each step, map its request-payload source fields.
   5. Save the combined API draft, then select Generate.
4. Register specifications with a wrapper API service.
   1. Ensure that a wrapper API service is running and select the Deploy tab.
   2. Select a generated token specification, account specification, both specifications, or provide a custom JSON body.
   3. Enter the wrapper API host URL.
   4. Select an Oracle Blockchain Platform Besu environment so the request can reuse its authentication and TLS settings.
   5. Review the registration preview and register the selected specifications.

Registration posts to the wrapper API service's /register endpoint. The tool can use a selected Oracle Blockchain Platform environment's private CA path or explicit self-signed setting for the registration request; it does not deploy the service itself.

Troubleshooting

Condition	Resolution
Artifacts or manifest are missing	Compile the selected project and confirm that the generated/imported package files exist.
No endpoints are generated	Select at least one method for wrapper API generation, or save at least one valid combined API.
ORDS generation fails	Provide an ORDS Swagger/OpenAPI JSON file and confirm that the project plug-in supports the --ords-swagger option. Inspect the full plug-in log for schema or operation errors.
Combined API is rejected	Check the API name/path, ordered steps, and request-field mappings, then save the draft again.
Registration is unavailable	Generate endpoint specification files first, then select an Oracle Blockchain Platform Besu environment and provide a reachable wrapper API host URL.