Generar una especificación de API de envoltorio y una recopilación de Postman

Puede utilizar Blockchain App Builder para crear archivos de especificación de punto final de cuenta/identidad y token filtrados y una recopilación de Postman coincidente.

Confirme que el archivo package.json incluye hardhat-plugin-obp-besu-wrapper-api y que la configuración de Hardhat lo importa. Seleccione un paquete de tokens generado con un manifiesto y artefactos de token/cuenta compilados. La herramienta detecta paquetes compuestos a partir de su manifiesto generado y también admite manifiestos de proyecto de referencia importados compatibles. No despliega ni inicia un servicio de API de envoltorio. El servicio de API de envoltorio ya se ha ejecutado como parte de la configuración de la instancia.

  1. Genere especificaciones de token y cuenta.
    1. Abra Herramientas para desarrolladores y seleccione Generar especificación de API de contenedor y recopilación de Postman.
    2. En Configuración, seleccione el proyecto Hardhat, el paquete de tokens y una carpeta de salida dentro del proyecto.
    3. En Asignación, revise las API de token y las API de cuenta/identidad. Mantenga Generar API de envoltorio seleccionadas para cada método que permanecerá en la especificación de punto final. Edite la ruta de acceso del punto final cuando sea necesario.
    4. Seleccione Generar para escribir los archivos JSON de especificación de cuenta y token filtrados y la recopilación Postman.
  2. Agregue puntos finales de ORDS Swagger/OpenAPI.
    1. En la vista Asignación, seleccione API de ORDS. La herramienta solo admite la entrada de la API de ORDS.
    2. Seleccione un archivo JSON ORDS Swagger/OpenAPI.
    3. Vuelva a generar los activos de envoltorio.
  3. Cree una API combinada, que defina un flujo de trabajo secuencial que combine el token o los métodos de cuenta seleccionados en un punto final de API de envoltorio.
    1. En Asignación, seleccione Usar en API combinada para cada método elegible.
    2. Seleccione Crear API combinada.
    3. Introduzca el nombre de la API combinada y la ruta de acceso del punto final.
    4. Revise y reordene los pasos seleccionados. Para cada paso, asigne sus campos de origen de carga útil de solicitud.
    5. Guarde el borrador de API combinado y, a continuación, seleccione Generar.
  4. Registre las especificaciones con un servicio de API de envoltorio.
    1. Asegúrese de que se está ejecutando un servicio de API de envoltorio y seleccione el separador Desplegar.
    2. Seleccione una especificación de token generada, una especificación de cuenta, ambas especificaciones o proporcione un cuerpo JSON personalizado.
    3. Introduzca la URL de host de la API de envoltorio.
    4. Seleccione un entorno Besu de Oracle Blockchain Platform para que la solicitud pueda reutilizar su configuración de autenticación y TLS.
    5. Revise la vista previa de registro y registre las especificaciones seleccionadas.

El registro se publica en el punto final /register del servicio de API de envoltorio. La herramienta puede utilizar una ruta de acceso de CA privada del entorno de Oracle Blockchain Platform seleccionada o una configuración autofirmada explícita para la solicitud de registro; no despliega el servicio en sí.

Solución de problemas

Condición Resolución
Faltan los artefactos o el manifiesto Compile el proyecto seleccionado y confirme que los archivos de paquete generados/importados existen.
No se han generado puntos finales Seleccione al menos un método para la generación de API de envoltorio o guarde al menos una API combinada válida.
Fallo de generación de ORDS Proporcione un archivo JSON ORDS Swagger/OpenAPI y confirme que el plugin del proyecto admite la opción --ords-swagger. Inspeccione el log completo del plugin en busca de errores de esquema u operación.
Se ha rechazado la API combinada Compruebe el nombre/ruta de la API, los pasos ordenados y las asignaciones de campo de solicitud y, a continuación, vuelva a guardar el borrador.
El registro no está disponible Genere primero los archivos de especificación de punto final y, a continuación, seleccione un entorno de Oracle Blockchain Platform Besu y proporcione una URL de host de API de envoltorio accesible.