Visual Studio Codeを使用したラッパーAPIの生成

ブロックチェーン・アプリケーション・ビルダーの拡張バージョンでは、Visual Studio CodeでラッパーAPIを生成できます。

Visual Studio CodeでラッパーAPIを生成すると、選択場所に存在する以前のラッパーAPIパッケージを上書きするかどうかを確認するプロンプトが表示されます。

APIゲートウェイは、単一のデプロイメントで作成できるルートの数を50に制限します。50を超えるラッパーAPIを生成しようとすると、複数のゲートウェイを作成するかどうかを確認するプロンプトが表示されます。同じデプロイメント・パス接頭辞を使用して複数のゲートウェイを作成すると、すべてのラッパーAPIエンドポイントで一貫したベース・パスが維持されます。複数のゲートウェイを作成しないことを選択した場合、ラッパーAPIの生成は取り消されます。次のステップの説明に従って、既存のゲートウェイを再利用することもできます。

  1. 「Chaincodes」ペインでチェーンコードプロジェクトを選択します。
  2. チェーンコード名を右クリックし、「ラッパーAPIパッケージの生成」を選択します。「Oracle Blockchain Platform - Wrapper API Package Generation」ペインが開きます。
  3. 次の表の説明に従って、構成変数を入力します。
    フィールド 説明 デフォルト値
    コンパートメントのOCID Oracle Cloud Infrastructure (OCI)内のコンパートメントOCID。 なし
    コンパートメント名 OCIコンパートメントの名前。 なし
    アイデンティティ・ドメイン 使用するアイデンティティ・ドメイン。 なし
    ブロックチェーン・チャネル チェーンコードがデプロイされるOracle Blockchain Platformチャネルの名前。 なし
    ブロックチェーンURL チェーンコード・デプロイメントに関連付けられたOracle Blockchain Platform URL。 なし
    場所 ラッパーAPIパッケージを生成するシステム・ディレクトリ。 なし
    新規APIゲートウェイ APIゲートウェイを作成するには、「はい」を選択し、「ゲートウェイ表示名」を指定します。既存のAPIゲートウェイを再利用するには、「いいえ」を選択し、既存のAPIゲートウェイに対して次の形式で再利用するOracle Cloud識別子(OCIDs)の配列を指定します。50ラッパーAPIごとに1つのゲートウェイを指定する必要があります。 
    ["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 (小文字)
  4. 「保存」をクリックします。
  5. 「マッピング」タブをクリックします。「マッピング」ペインには、チェーンコードで使用可能なすべてのコントローラAPIの表が表示されます。各メソッドには対応するAPIエンドポイントがあり、必要に応じて編集できます。対応する「ラッパーAPIの生成」チェック・ボックスを選択して、ラッパーAPIパッケージにコントローラAPIを含めます。「すべて選択」をクリックして、すべてのコントローラAPIを含めます。
  6. 「保存」をクリックします。
  7. 「生成」をクリックします。ラッパーAPIパッケージおよび関連付けられたPostmanコレクションが生成されます。