チュートリアル: JSON コンテンツのマッピング

このチュートリアルでは、メッセージの内容をある形式またはスキーマから、別の形式またはスキーマにマップする方法を説明します。

開始前に

このタスクを実行できるのは、以下のロールのいずれかを割り当てられているユーザーです。

カタログ所有者
開発者

注： Sandboxカタログは、 DataPower® Gateway (v5 compatible) 、 DataPower API Gateway 、またはその両方を使用するように設定する必要があります。「カタログの作成と設定」を参照してください。

このチュートリアルについて

このチュートリアルでは、以下のレッスンを行います。

新規 API の作成
JSON コンテンツのマップ

新規 API の作成

新規 API を作成するには、以下のステップを実行します。

API Managerにログインする。
Home ページで、 Develop APIs and Products タイルをクリックします。
または、左のパネルにある「現像」アイコンをクリックします。
「開発」ページで、「追加」>「 API 」をクリックします。
APIタイプの選択ページで
1. 「OpenAPI 2.0」が選択されていることを確認します。
2. New OpenAPI ラジオボタンを選択する。
3. 次へをクリックします。
Create new OpenAPI 」ページで、APIに関する以下の情報を入力する。
注: OpenAPI バージョンフィールドは事前定義されています。このフィールドは更新できません。
1. タイトルの欄に、 Mapper と入力する。
  名前」フィールドには、「タイトル」フィールドに入力した値が入る。
2. Version 欄に 1.0.0 と入力する。
3. ベース・パス・フィールドに /map と入力する。
4. 次へをクリックします。
セキュア」セクションで
1. 「クライアント ID を使用して保護する」および「 CORS 」のチェックボックスが事前に選択されています。チェックボックスの選択は外さないでください。
2. 次へをクリックします。
  新しいAPIが作成されるにつれ、進捗状況が表示される。 APIが作成されると、Summaryが表示される。
Summary セクションで、 Edit APIをクリックする。
API 定義のドラフト用の Design タブが表示されます。
左のパネルで、 Consumes をクリックする。
右パネルの「 Consumes」セクション、
1. Add +をクリックする。
2. Add schema ダイアログ・ボックスで、 Mime Type (optional) ドロップダウン・リストから application/json を選択し、 Add をクリックする。
左のパネルで、 Producesをクリックする。
右パネルの Produces セクション、
1. Add +をクリックする。
2. Add schema ダイアログ・ボックスで、 Mime Type (optional) ドロップダウン・リストから application/json を選択し、 Add をクリックする。
左のパネルで、 Pathsをクリックする。
右パネルの「パス」セクション、
1. Add +をクリックする。
2. パス名フィールドに「 /jsonmap 」と入力し、「追加」をクリックする。
左側のパネルで、新しく作成したパス（/jsonmap ）の下、 Operationsの横にある + アイコンをクリックする。
Add schema ダイアログ・ボックスが表示されます。
スキーマの追加ダイアログ・ボックスで、以下のタスクを実行する。
1. 動詞（キー）（オプション）フィールドに、 get と入力する。
2. Operation（オプション）フィールドに「 POST 」と入力する。
3. 追加をクリックします。
左のパネルの「パラメータ」の横にある「＋」アイコンをクリックする。
Add schema ダイアログ・ボックスが表示されます。
スキーマの追加ダイアログ・ボックスで、以下のタスクを実行する。
1. Name フィールドに body と入力する。
2. Required チェックボックスを選択します。
3. Located Inのドロップダウンリストから、 body を選択します。
4. 追加をクリックします。
スキーマ・セクションまでスクロールダウンし、「表示」をクリックする。
Schema セクションで、以下のタスクを実行する。
1. タイトル（オプション）には、 body と入力してください。
2. Type drop down listから stringを選択する。
3. 右上の「保存」をクリックする。
左側のパネルで、「パス」＞「操作」＞「応答」を展開します。
応答] で、[ 200] をクリックします。
右パネルの「 200」セクションで、以下のタスクを実行する。
1. Name (Key) に 200 と入力する。
2. 説明フィールドには、 200 OK と入力する。
3. 右上の「保存」をクリックする。

JSON コンテンツのマップ

ゲートウェイ」タブをクリックします。
キャンバス上の既存のポリシーを削除するには、そのポリシーにカーソルを合わせ、 [削除 ] アイコンをクリックします。
注： DataPower API Gateway を使用している場合、ポリシーは invoke ポリシーであり、 DataPower Gateway (v5 compatible) を使用している場合、ポリシーは proxy ポリシーである。
パレットを表示するには、右側のパネルにあるプラスアイコンをクリックしてください。
Transforms 列で、 map を選択する。
マップポリシーノードがキャンバスに表示されます。
マップポリシーノードをクリックして、設定ダイアログボックスを開きます。
「入力」の横にある「入力の編集」アイコンをクリックします。
Add inputをクリックする。
以下の値を入力して、マップ入力設定を完了する
1. コンテキスト変数フィールドに、 request.body と入力する。
2. Name フィールドに input と入力する。
3. コンテンツタイプのドロップダウンリストから、 application/json を選択します。
4. 定義」のドロップダウンリストから、 Inline schema を選択する。
  Provide a schema ポップアップ・ウィンドウが表示されます。
5. Provide a schema ポップアップ・ウィンドウで、以下のタスクを実行する。
  1. サンプルJSONから生成 ]タブを選択します。
  2. 以下のサンプル JSON をボックスに貼り付けます。
```
{"order":
{"customer":
{"name":
{
"firstname":"John",
"middlename":"Q",
"lastname":"Smith"
},
"address":
{
"line1":"550 King St",
"line2":"Dept 5",
"city":"Littleton",
"state":"MA",
"country":"USA",
"code":"01460"
}
}
},
"items":
[{"item":"shoes", "color":"black", "qty":2, "price":23.50},
{"item":"socks", "color":"argyle", "qty":2, "price":3.95},
{"item":"pants", "color":"grey", "qty":1, "price":48.00}]
}
```
  3. 生成」をクリックする。
  4. 「完了」をクリックします。
    ポップアップウィンドウが閉じました。
6. マップポリシーの設定ダイアログボックスで、[ 完了] をクリックしてマップの設定を完了します。
「出力」列の横にある「出力の編集」アイコンをクリックします。
Add outputをクリックする。
以下の値を入力して、マップ出力設定を完了する
1. コンテキスト変数フィールドに、 message.body と入力する。
2. Name フィールドに output と入力する。
3. コンテンツタイプのドロップダウンリストから、 application/json を選択します。
4. 定義」のドロップダウンリストから、 Inline schema を選択する。
  Provide a schema ポップアップ・ウィンドウが表示されます。
5. Provide a schema ポップアップ・ウィンドウで、以下のタスクを実行する。
  1. サンプルJSONから生成 ]タブを選択します。
  2. 以下のサンプル JSON をボックスに貼り付けます。
```
{"order":
{
"date":"12-12-12",
"customer": "John Smith",
"address":
{
"street":"king",
"citystatezip":"lit MA 01469",
"country":"USA"
},
"items":[{"type":"shoes", "color":"black", "qty":2, "price":23.50}]
}
}
```
  3. 生成」をクリックする。
6. 「完了」をクリックします。
  ポップアップウィンドウが閉じました。
7. マップポリシーの設定ダイアログボックスで、[ 完了] をクリックしてマップの設定を完了します。
保存をクリックします。
マップ出力設定ウィンドウの出力欄で、以下のタスクを実行する。
1. 日付のラジオボタンを選択します。
  Configure mapping ダイアログボックスが表示されます。
  1. マッピングの設定ダイアログボックスで、以下のサンプル JavaScript を入力します。
    new Date().toGMTString()
  2. 「完了」をクリックします。
2. 入力」列で「firstname」ラジオボタンを選択し、「出力」列で「 customer」ラジオボタンを選択します。
  Configure mapping ダイアログボックスが表示されます。
  1. マッピングの設定ダイアログボックスで、デフォルト値として空の文字列チェックボックスを選択します。
  2. 「完了」をクリックします。
3. 入力欄で「middlename」ラジオボタンを選択し、出力欄で「 customer 」ラジオボタンを選択する。
  Configure mapping ダイアログボックスが表示されます。
  1. マッピングの設定ダイアログボックスで、デフォルト値として空の文字列チェックボックスを選択します。
  2. 「完了」をクリックします。
4. Input」列で「lastname」ラジオボタンを選択し、「 Output」列で「 customer」ラジオボタンを選択します。
  Configure mapping ダイアログボックスが表示されます。
  1. マッピングの設定ダイアログボックスで、デフォルト値として空の文字列チェックボックスを選択します。
  2. 「完了」をクリックします。
5. 出力欄で、顧客のラジオボタンを選択します。
  Configure mapping ダイアログボックスが表示されます。
  1. Configure mapping ダイアログ・ボックスの Value フィールドに、以下のサンプル・コードを入力する。
```
var name = $(input.order.customer.name.firstname) + ' '; 
  if($(input.order.customer.name.middlename)) {
  name += $(input.order.customer.name.middlename) + ' ';}
  name += $(input.order.customer.name.lastname);
  name
```
  2. 「完了」をクリックします。
6. 「入力」列で、「住所」>「 line1 」のラジオボタンを選択し、次に「出力」列で「通り」のラジオボタンを選択します。
  Configure mapping ダイアログボックスが表示されます。
  1. マッピングの設定ダイアログボックスで、デフォルト値として空の文字列チェックボックスを選択します。
  2. 「完了」をクリックします。
7. 「入力」列で、「住所」>「 line2 」のラジオボタンを選択し、次に「出力」列で「通り」のラジオボタンを選択します。
  Configure mapping ダイアログボックスが表示されます。
  1. マッピングの設定ダイアログボックスで、デフォルト値として空の文字列チェックボックスを選択します。
  2. 「完了」をクリックします。
8. 出力欄で、通りのラジオボタンを選択する。
  Configure mapping ダイアログボックスが表示されます。
  1. Configure mapping ダイアログ・ボックスの Value フィールドに、以下のサンプル・コードを入力する。
```
var street = $(input.order.customer.address.line1) + ' '; 
  if($(input.order.customer.address.line2)) {
  street += $(input.order.customer.address.line2);}
  street
```
  2. 「完了」をクリックします。
9. 入力」欄で「市区町村」のラジオボタンを選択し、「出力」欄で「citystatezip」のラジオボタンを選択する。
  Configure mapping ダイアログボックスが表示されます。
  1. マッピングの設定ダイアログボックスで、デフォルト値として空の文字列チェックボックスを選択します。
  2. 「完了」をクリックします。
10. 入力」欄で「州」ラジオボタンを選択し、「出力」欄で「 citystatezip」ラジオボタンを選択する。
  Configure mapping ダイアログボックスが表示されます。
  1. マッピングの設定ダイアログボックスで、デフォルト値として空の文字列チェックボックスを選択します。
  2. 「完了」をクリックします。
11. 入力」列で「コード」ラジオボタンを選択し、「出力」列で「 citystatezip」ラジオボタンを選択する。
  Configure mapping ダイアログボックスが表示されます。
  1. マッピングの設定ダイアログボックスで、デフォルト値として空の文字列チェックボックスを選択します。
  2. 「完了」をクリックします。
12. 出力欄で、通りのラジオボタンを選択する。
  Configure mapping ダイアログボックスが表示されます。
  1. Configure mapping ダイアログ・ボックスの Value フィールドに、以下のサンプル・コードを入力する。
```
$(1) + " " + $(2) + " " + $(3)
```
    注：変数参照は位置指定であり、$(1)は最初にマップされた値（input.order.customer.city ）を指し、以下同様である。
  2. 「完了」をクリックします。
13. 「入力」列で、「項目 > 項目」のラジオボタンを選択し、続いて「出力」列で「項目」のラジオボタンを選択します。
  Configure mapping ダイアログボックスが表示されます。
  1. マッピングの設定ダイアログボックスで、デフォルト値として空の文字列チェックボックスを選択します。
  2. 「完了」をクリックします。
14. 出力列の下にある、2番目の追加プロパティをクリックする。
  1. 最初のフィールドに total と入力する。
  2. ドロップダウンリストから、 float を選択する。
  3. アイコンをクリックする。
15. 入力欄で項目のラジオボタンを選択し、出力欄で合計のラジオボタンを選択する。
  Configure mapping ダイアログボックスが表示されます。
  1. Configure mapping ダイアログ・ボックスの Value フィールドに、以下のサンプル・コードを入力する。
```
$(0) + ($(input.items.price) * $(input.items.qty))
```
  2. 「完了」をクリックします。
16. マップポリシーノードの出力ページで、[ 保存] をクリックします。
ソースをクリックする。
スクロールダウンし、合計が計算されるコードを見つけます。
コード foreach: input.items のある新規行を挿入します。
保存をクリックします。

API 定義のテスト

注：クロスオリジンリソース共有（ CORS ）の制限により、 macOS Catalinaプラットフォーム上のChromeまたはSafariブラウザでは、アセンブリテストツールを使用できません。

API Manager テストツールを使用してAPI定義をテストするには、以下の手順を実行します：

Assembleをクリックする。
「テスト」アイコンをクリックしてください。テスト・ツールが開きます。
ActivateAPIをクリックする。
Operation フィールドで、 post /jsonmapを選択する。

「本文」フィールドに、以下の JSON テキストを入力します。

{"order":
{"customer":
{"name":
{
"firstname":"John",
"middlename":"Q",
"lastname":"Smith"
},
"address":
{
"line1":"550 King St",
"line2":"Dept 5",
"city":"Littleton",
"state":"MA",
"country":"USA",
"code":"01460"
}
}
},
"items":
[{"item":"shoes", "color":"black", "qty":2, "price":23.50},
{"item":"socks", "color":"argyle", "qty":2, "price":3.95},
{"item":"pants", "color":"grey", "qty":1, "price":48.00}]
}

テストセレクトオペ

Invokeをクリックする。応答が表示されます。 date、street、citystatezip、および total の各フィールドの値は、以前に定義したマッピング式を反映していることに注意してください。
注：自己署名証明書を使用している場合、提供された URL にアクセスするよう促されることがある。リンクをクリックし、証明書を承認してから API Managerに戻り、再度 Invokeをクリックする。

API 定義の管理

新しいAPIが期待通りに動作するようになったので、その管理を始めることができる。即時のオプションを確認するには、以下の手順を実行します。

ナビゲーションパネルで、[ 開発] アイコンをクリックします。
Mapper API の横にあるメニューアイコンをクリックし、「ダウンロード」を選択します。

このチュートリアルで実行したこと

新規 API の作成
ある JSON スキーマから別のスキーマにコンテンツをマップ