JSON (RESTful) オペレーション

JSON (RESTful) サービスインターフェイスオペレーションを作成するための重要な仕様を提供します。

JSON (RESTful) サービスインターフェイスを定義する場合、選択した COBOL エントリポイントのグループ構造に基づいて一連のオペレーションを作成するオプションがあります。[API Resources] ウィザードを介して一連のオプションが表示されます。このウィザードに表示されるオプションは、サービスインターフェイスに指定された COBOL エントリポイントから派生します。

ヒント: 「Tutorial: JSON RESTful Web Service using API Resources」を通読し、この機能に慣れることをお勧めします。

[API Resources] ウィザードには、選択したエントリポイントの COBOL グループ項目ごとに 1 つのリソースエントリが表示されます。一般に、各リソースに選択されるデフォルトメソッドは、グループ項目を取得するための GET オペレーション、および項目を更新するための PUT オペレーションです。ゼロ以外の OCCURS 句で定義された各 COBOL グループ項目 (配列) については、2 つの個別のリソースエントリが次のように表示されます。

最初のエントリは、配列リソースによって定義されたコレクション全体にアクセスするためのものです。デフォルトでは、このリソース選択には、コレクション全体を取得するために選択された GET メソッド、およびシングルトンリソース (単一の要素) をコレクションに追加するための POST メソッドがあります。
2 番目のエントリは、コレクション内のシングルトンリソースにアクセスするためのエントリです。デフォルトでは、このリソース選択には、コレクションの項目を取得するために選択された GET メソッド、項目を更新するための PUT メソッド、およびコレクションから項目を削除するための DELETE メソッドがあります。

[API Resources] ウィザードに一覧表示される各 COBOL リソースに提供されるデフォルトの相対パスは、リソースで定義されたフィールドグループから派生し、要求 URI の相対パス部分を表します。詳細については、「HTTP メソッド/パス」を参照してください。

重要: [OK] をクリックしてオペレーションを作成する前に、 [API Resources] ウィザードにリストされているリソースの一部またはすべてを選択し、選択したリソースのデフォルトパスおよびメソッド設定を変更できます。詳細については、「新しい API リソースオペレーションを生成するには」を参照してください。

Visual COBOL は、選択した各リソースの選択したメソッドごとに、新しい別のオペレーションを作成します。たとえば、選択した 1 つのリソースに対して GET メソッドと PUT メソッドの両方を選択した場合、Visual COBOL は 2 つのオペレーション (GET メソッド用に 1 つ、PUT メソッド用に 1 つ) を作成します。

結果として作成されるオペレーションは、次のように定義されています。

GET オペレーションには、COBOL グループにマップされ、COBOL グループと同じ Occurs 値を持つインターフェイスフィールドグループがあります。
POST オペレーションには、COBOL グループにマップされたインターフェイスフィールドグループがありますが、その Occurs 値は 1 です。
PUT オペレーションおよび DELETE オペレーションには、それぞれ COBOL グループにマップされたインターフェイスフィールドグループがありますが、その Occurs 値は 1 です。さらに、それぞれに、オペレーションを識別する相対 URI パス内のパラメーターに対応するパス型インターフェイスフィールドがあります。このパス型フィールドは、コレクション内のどの項目にアクセスするかを識別する索引として使用するためのものです。
注: 相対 URI パスの詳細については、「HTTP メソッド/パス」を参照してください。パス型フィールドの詳細については、「[Body]、[Path]、および [Query] のフィールド」を参照してください。

次のトピックでは、JSON (RESTful) サービスインターフェイスの概念に関する重要な詳細を説明します。