使用 Visual Studio Code 生成包装 API
Blockchain App Builder 的增强版本使您能够在 Visual Studio Code 中生成包装 API。
在 Visual Studio Code 中生成包装 API 时,系统会提示您是否覆盖选择位置中存在的任何以前的包装 API 软件包。
API 网关将单个部署中可以创建的路由数限制为 50 个。如果您尝试生成超过 50 个包装 API,系统会提示您是否创建多个网关。创建具有相同部署路径前缀的多个网关将在所有包装 API 端点之间保持一致的基本路径。如果您选择不创建多个网关,将取消包装 API 生成。还可以重用现有网关,如以下步骤中所述。
- 在 Chaincodes 窗格中选择链代码项目。
- 右键单击链代码名称,然后选择 Generate Wrapper API Package 。此时将打开 Oracle Blockchain Platform - Wrapper API Package Generation(包装 API 程序包生成)窗格。
- 按下表中所述输入配置变量。
域 说明 默认值 区间 OCID Oracle Cloud Infrastructure (OCI) 中区间的 OCID。 无 区间名称 OCI 区间的名称。 无 身份域 要使用的身份域。 无 区块链渠道 部署链代码的 Oracle Blockchain Platform 通道的名称。 无 区块链 URL 与链代码部署关联的 Oracle Blockchain Platform URL。 无 存储位置 用于生成包装 API 软件包的系统目录。 无 新建 API 网关 要创建 API 网关,请选择是,然后指定网关显示名称。要重用现有 API 网关,请选择否,然后为现有 API 网关指定要以以下格式重用的 Oracle Cloud 标识符 (OCID) 数组。必须为每 50 个包装 API 指定一个网关。 ["ocid1.apigateway.xxx", "ocid1.apigateway.yyy"]
需要 部署路径前缀 API 网关中的部署路径前缀,用于指定部署路由的路径。部署路径前缀必须以斜杠 (/) 开头。 /<ChaincodeName> 区块链同步 要包括在 API 调用有效负载中的同步值。 true 区块链超时 要包括在 API 调用有效负载中的超时值。 6,000 策略名称 该策略的名称,通过为组织中的组和区间定义的权限来控制对 API 的管理和访问 ChaincodeName VCN 显示名称 OCI 虚拟云网络的显示名称。 ChaincodeName 应用程序显示名称 OCI 应用程序的显示名称。 ChaincodeName 网关显示名称 API 网关的显示名称。 ChaincodeName 部署显示名称 API 网关的显示名称。 ChaincodeName OCI 资料档案库名称 OCI 注册表存储库名称,必须全部为小写字母。 以小写字符表示的 ChaincodeName - 单击保存。
- 单击映射选项卡。"Mapping"(映射)窗格显示链代码中可用的所有控制器 API 的表。每个方法都有一个对应的 API 端点,您可以根据需要进行编辑。选中相应的 Generate Wrapper APIs(生成包装 API)复选框,以在包装 API 软件包中包含控制器 API。单击全选以包括所有控制器 API。
- 单击保存。
- 单击生成。将生成包装 API 包和关联的 Postman 集合。