生成包装 API 规范和 Postman 集合

您可以使用区块链应用程序构建器创建筛选的令牌和账户/身份端点规范文件以及匹配的 Postman 集合。

确认 package.json 文件包含 hardhat-plugin-obp-besu-wrapper-api，并且 Hardhat 配置会导入该文件。选择生成的带有清单和已编译的标记/账户构件的标记包。该工具从生成的清单中搜索组合的软件包，并且还支持兼容的导入引用项目清单。它不部署或启动包装 API 服务。包装 API 服务已在实例设置过程中运行。

1. 生成令牌和账户规范。
   1. 打开开发人员工具，然后选择生成包装 API 规范和 Postman 集合。
   2. 在配置中，选择项目中的 Hardhat 项目、令牌包和输出文件夹。
   3. 在映射中，查看令牌 API 和账户/身份 API。为将保留在端点规范中的每种方法选择生成包装 API 。根据需要编辑端点路径。
   4. 选择生成以写入筛选的标记和帐户规范 JSON 文件以及 Postman 集合。
2. 添加 ORDS Swagger/OpenAPI 端点。
   1. 在映射视图中，选择了 ORDS API 。该工具仅支持 ORDS API 输入。
   2. 选择 ORDS Swagger/OpenAPI JSON 文件。
   3. 再次生成包装资产。
3. 创建组合 API，该 API 定义将所选标记或账户方法合并到一个包装 API 端点的顺序工作流。
   1. 在映射中，为每个合格方法选择用于组合 API 。
   2. 选择创建组合 API 。
   3. 输入组合的 API 名称和端点路径。
   4. 检查所选步骤并对其重新排序。对于每个步骤，映射其请求有效负载源字段。
   5. 保存组合的 API 草稿，然后选择生成。
4. 在包装器 API 服务中注册规范。
   1. 确保包装器 API 服务正在运行，然后选择部署选项卡。
   2. 选择生成的标记规范、账户规范和两个规范，或者提供定制 JSON 正文。
   3. 输入包装 API 主机 URL。
   4. 选择 Oracle Blockchain Platform Besu 环境，以便请求可以重用其验证和 TLS 设置。
   5. 查看注册预览并注册所选规范。

注册发布到包装 API 服务的 /register 端点。该工具可以为注册请求使用所选 Oracle Blockchain Platform 环境的专用 CA 路径或显式自签名设置；它不部署服务本身。

故障排除

条件	解决方法
缺少构件或清单	编译所选项目并确认生成的/导入的软件包文件是否存在。
未生成端点	至少选择一个用于生成包装 API 的方法，或者至少保存一个有效的组合 API。
ORDS 生成失败	提供 ORDS Swagger/OpenAPI JSON 文件并确认项目插件支持 --ords-swagger 选项。检查完整的插件日志以了解方案或操作错误。
已拒绝组合 API	检查 API 名称/路径、排序步骤和请求字段映射，然后再次保存草稿。
注册不可用	首先生成端点规范文件，然后选择 Oracle Blockchain Platform Besu 环境并提供可访问的包装 API 主机 URL。