CLIを使用したPostmanコレクションの生成
generate
コマンドを使用して、すべてのチェーンコード・コントローラAPIのペイロード例を含むPostmanコレクションを作成できます。
Postmanは、REST APIの操作およびテストに使用できるツールです。generateコマンドは、宣言仕様ファイルから自動的に生成されたチェーンコードに基づくPostmanコレクションを作成します。Postmanコレクションには、チェーンコード・コントローラ・ファイルで指定されたすべてのメソッドのペイロードが含まれます。Postmanコレクション・ファイルの変数値を変更して、REST APIコールを実行できます。
生成されたPostmanコレクションには、コントローラ内のすべてのAPIのデフォルト値が含まれます。Postmanの詳細は、https://www.postman.com/を参照してください。Postmanコレクションを生成した後、ペイロードおよび変数のデフォルト値を変更することで、それを直接インポートして使用できます。
使用方法:
generate [options]
my-mac:TsProject myname$ ochain generate -h
Usage: generate [options]
Generates the postman collection for the chaincode.
Options :
-h, --help output command usage information
-D, --debug enable debug logging
-c, --collection This option is mandatory to generate a Postman collection.
-p, --project <path> Path to the chaincode project to generate the Postman collection from. If not specified, it defaults to current directory.
-o, --out <path> Path to the generated Postman collection JSON file. If not specified, it defaults to current directory.
Postmanコレクションを生成するには、プロジェクトを含むディレクトリに移動し、次のコマンドを入力します。チェーンコード・ディレクトリからgenerate
コマンドを実行する必要があります。実行しないと、エラーが発生します。指定されたPostmanコレクションがすでに存在する場合は、上書きするかどうかを尋ねられます。
ochain generate --collection --project path_to_chaincode_project --out path_to_postman_collection_to_generate
Postmanコレクション構造
- 起動リクエストには、エンドポイント
/transactions
を使用するすべての書込み操作が含まれます。 - 問合せリクエストには、エンドポイント
/chaincode-queries
を使用するすべてのget操作が含まれます。
コントローラAPIのgetterメソッドとgetter以外のメソッドを区別するために、TypeScriptチェーンコードでデコレータが使用され、Goチェーンコードでコメントが使用されます。コントローラでgetterメソッドを定義する場合は、次の表に示すように、TypeScriptにGetMethodデコレータを使用するか、GoにGetMethodコメントを使用する必要があります。
TypeScript | 移動 |
---|---|
すべてのgetterメソッドには、GetMethod デコレータがあります。
|
すべてのgetterメソッドには、GetMethod コメント・ブロックがあります。
|
生成されたPostmanコレクションには、次の表に示すように、デフォルト値を持つ変数が含まれます。
変数名 | 説明 | デフォルト値 | コンテキスト |
---|---|---|---|
bc-url |
チェーンコードがデプロイされているOracle Blockchain PlatformインスタンスのRESTプロキシURL | https://test-xyz-abc.blockchain.ocp.oraclecloud.com:7443/restproxy |
すべてのチェーンコード |
bc-channel |
チェーンコードがデプロイされるチャネル | default |
すべてのチェーンコード |
bc-admin-user |
管理ユーザーの名前(すべてのPOSTリクエストにアクセスできる管理ロールを持つユーザー)。デフォルトでは、このユーザーはチェーンコード内のすべてのPOSTリクエストのコール元です。 | bc-admin-user value |
すべてのチェーンコード |
bc-admin-password |
adminユーザーのパスワード | bc-admin-password value |
すべてのチェーンコード |
bc-timeout |
タイムアウト間隔を示す各POSTリクエストの本文内のタイムアウト値 | 6000 |
すべてのチェーンコード |
bc-sync |
リクエストが同期か非同期かを示す、すべてのPOSTリクエストの本文内の同期値 | true |
すべてのチェーンコード |
bc-chaincode-name |
チェーンコード名。すべてのPOSTリクエストで使用されます。 | chaincode name |
すべてのチェーンコード |
bc-org-id |
すべてのPOSTリクエストに対するデフォルトのorgId パラメータ
|
bc-org-id value |
トークンチェーンコードのみ |
bc-user-id |
すべてのPOSTリクエストに対するデフォルトのuserId パラメータ
|
bc-user-id value |
トークンチェーンコードのみ |
bc-token-id |
すべてのPOSTリクエストに対するデフォルトのtokenId パラメータ
|
bc-token-id value |
トークンチェーンコードのみ |
生成されたすべてのリクエストで、デフォルト値を持つすべてのパラメータが生成されます。構造体/クラス・パラメータを持つ関数は、次の例に示すように、リクエスト本文にプレースホルダ・オブジェクトを持ちます。
- 構造体/クラスパラメータを持つAPI
-
{ "chaincode": "{{bc-chaincode-name}}", "args": [ "CreateArtCollectionToken", "{\"TokenId\":\"{{bc-token-id}}\",\"TokenDesc\":\"TokenDesc value\",\"TokenUri\":\"TokenUri value\",\"TokenMetadata\":{\"Painting_name\":\"Painting_name value\",\"Description\":\"Description value\",\"Image\":\"Image value\",\"Painter_name\":\"Painter_name value\"},\"Price\":999,\"On_sale_flag\":true}", "quantity value" ], "timeout": {{bc-timeout}}, "sync": {{bc-sync}} }
- 構造体/クラスパラメータのないAPI
-
{ "chaincode": "{{bc-chaincode-name}}", "args": [ "CreateAccount", "{{bc-org-id}}", "example_minter", "true", "true" ], "timeout": {{bc-timeout}}, "sync": {{bc-sync}} }
ほとんどのAPIパラメータのデフォルト値はparameter_name value
ですが、例外もあります。次の例は、いくつかの例外を示しています。
GetAccountTransactionHistoryWithFilters
のfiltersパラメータ:"{\"PageSize\":20,\"Bookmark\":\"\",\"StartTime\":\"2022-01-16T15:16:36+00:00\",\"EndTime\":\"2022-01-17T15:16:36+00:00\"}"
GetSubTransactionsByIdWithFilters
のfiltersパラメータ:"{\"PageSize\":20,\"Bookmark\":\"\}"
構造体またはクラスのデフォルト値は、次の表に示すように異なります。
データ・タイプ | デフォルト値 |
---|---|
boolean/bool |
true |
int/number |
999 |
date |
2022-01-16T15:16:36+00:00 |
other |
parameter_name value |
ERC-1155トークン・プロジェクト
ERC-1155規格には、真菌性トークンと非真菌性トークンの両方に共通の方法が含まれています。真菌トークンと非真菌トークンの両方を使用するERC-1155プロジェクト用に生成されたPostmanコレクションには、これらの共通メソッド用に、トークンのタイプごとに1つずつ、2つの異なるPOSTリクエストが含まれます。ERC-1155プロジェクトがfungibleまたはnon-fungibleトークンのみを使用し、両方の型を使用しない場合、生成されたPostmanコレクションには、これらの共通メソッドに対するPOSTリクエストが1つのみ含まれます。次の表に、AddRole
メソッドに対して生成されたAPIを示します。
真菌トークン | 消毒性のないトークン | |
---|---|---|
リクエスト名 | AddRole -For Fungible |
AddRole -For NonFungible |
リクエストボディ |
|
|