テストリソースのビルドとエクスポート

このページの内容は Apigee と Apigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示する

注: Apigee と Apigee ハイブリッド 1.5 以降では、ローカル開発を使用します。

API をテストする前に、Apigee 組織内の本番環境に存在する可能性があるものと同じリソースに相当する API プロダクト、デベロッパー、アプリなど、一連のテストリソースのビルドが必要となる場合があります。

以降のセクションで説明するように、テストリソースをビルドしてエクスポートします。Apigee ワークスペースでのフォルダとファイルの管理もご覧ください。

始める前に: 次のトピックで説明されているコンセプトを理解しておいてください。

• API プロダクトとは
• アプリ デベロッパーの登録
• アプリ登録を使用した API へのアクセスの管理
• Key-Value マップの使用

テストリソースのビルド

テストリソースをビルドするには、テストバンドルを作成し、次の表に定義されているテストリソースを編集します。

リソースをテストする	説明
API プロダクト（products.json）	API をバンドルするために使用される API プロダクトを定義し、デベロッパーがその API プロダクトを使用できるようにします。
デベロッパー（developers.json）	API にアクセスするデベロッパーを登録します。
デベロッパー アプリ（developerapps.json）	API へのアクセスを制御するアプリを登録します。
Key-Value マップ（maps.json）	API がランタイム時に取得するデータの保存に使用する Key-Value マップ（KVM）を定義します。

テストバンドルの作成

Cloud Code でテストバンドルを作成するには:

1. 次のいずれかの操作を行います。

   • [Apigee] セクションの tests フォルダにカーソルを合わせ、 をクリックします。

   • [View] > [Command Palette] を選択して、コマンド パレットを開き、[Cloud Code: Create Apigee test bundle] を選択します。

2. テストバンドルの一意の名前を入力し、Enter キーを押します。

テストバンドルが、Apigee セクションの [tests] フォルダに追加されます。

以下のセクションの説明に沿って、テストリソースを構成します。

API プロダクトの定義（products.json）

API をバンドルするために使用される API プロダクトを定義し、デベロッパーがその API プロダクトを使用できるようにします。API プロダクトの詳細については、API プロダクトとはをご覧ください。

API プロダクトを定義するには、構成ウィザード（後述）を使用するか、product.json 構成ファイルを直接編集して、products.json ファイルを更新します。products.json ファイルのフィールドの説明については、リソース: ApiProduct をご覧ください。

構成ウィザードを使用して API プロダクトを定義するには:

1. テストバンドルの products.json ファイルにカーソルを合わせ、 をクリックします。[Create API product] ウィザードが開きます。

   

2. 構成ウィザードに沿って、products.json ファイル内のフィールドに自動入力します。エディタで products.json ファイルが開きます。

3. 必要に応じて、構成情報を編集します。

4. [ファイル] > [保存] を選択する、または ⌘+S キーを押して、編集内容を保存します。

次の例では、helloworld API プロキシを含む myapiproduct API プロダクトが定義されています。

[
  {
    "apiResources": [
      "/",
      "/*",
      "/**"
    ],
    "quota": "100",
    "quotaInterval": "1",
    "quotaTimeUnit": "minute",
    "name": "myapiproduct",
    "displayName": "My first API product",
    "proxies": [
      "helloworld"
    ]
  }
]

デベロッパーの登録（developers.json）

API にアクセスするデベロッパーを登録します。デベロッパーの詳細については、アプリ デベロッパーの登録をご覧ください。

デベロッパーを登録するには、構成ウィザード（後述）を使用するか、developers.json 構成ファイルを直接編集して developers.json ファイルを更新します。products.json ファイルのフィールドの説明については、リソース: Developer をご覧ください。

構成ウィザードを使用してデベロッパーを登録するには:

1. テストバンドルの developers.json ファイルにカーソルを合わせ、 をクリックします。
2. 構成ウィザードに沿って、developers.json ファイル内のフィールドに自動入力します。 エディタで developers.json ファイルが開きます。
3. 必要に応じて構成を編集します。
4. [ファイル] > [保存] を選択する、または ⌘+S キーを押して、編集内容を保存します。

次の例では、デベロッパー [e-mail] を定義します。

[
  {
    "email": "[e-mail]",
    "userName": "ahamilton",
    "firstName": "Alex",
    "lastName": "Hamilton"
  }
]

デベロッパー アプリの登録（developerapps.json）

API へのアクセスを制御するデベロッパー アプリを登録します。デベロッパー アプリの登録の詳細については、アプリを登録して API へのアクセスを制御するをご覧ください。

注: デベロッパー アプリを登録する前に、API プロダクトを定義してデベロッパーを登録することをおすすめします。

デベロッパー アプリを登録するには、構成ウィザード（後述）を使用するか、developerapps.json 構成ファイルを直接編集して、developerapps.json ファイルを更新します。developerapps.json ファイルのフィールドの説明については、リソース: DeveloperApp をご覧ください。

構成ウィザードを使用してデベロッパー アプリを登録するには:

1. テストバンドルの developerapps.json ファイルにカーソルを合わせ、 をクリックします。

2. 構成ウィザードに沿って、developerapps.json ファイル内のフィールドに自動入力します。エディタで developerapps.json ファイルが開きます。

3. 必要に応じて構成を編集します。

4. [File] > [Save] を選択するか、または ⌘+S キーを押して、編集内容を保存します。

次の例では、デベロッパー アプリ myapp を [e-mail] に登録して、myproduct を関連付けています。

[
  {
    "attributes": [
      {
        "name": "sample_attribute_0",
        "value": "sample_attribute_value_0"
      }
    ],
    "developerEmail": "[e-mail]",
    "name": "myapp",
    "callbackUrl": "",
    "keyExpiresIn": "",
    "apiProducts": [
      "myproduct"
    ]
  }
]

Key-Value マップの定義（maps.json）

API がランタイム時に取得するデータの保存に使用する Key-Value マップ（KVM）を定義します。KVM の詳細については、Key-Value マップの使用をご覧ください。

Key-Value マップを定義するには、構成ウィザード（後述）を使用するか、maps.json 構成ファイルを直接編集して、maps.json ファイルを更新します。maps.json ファイルのフィールドの説明については、KeyValueMap リソースをご覧ください。

構成ウィザードを使用してデベロッパー アプリを登録するには: 1. テストバンドルの maps.json ファイルにカーソルを合わせ、 をクリックします。2. 構成ウィザードに沿って、maps.json ファイル内のフィールドに自動入力します。エディタで maps.json ファイルが開きます。3. 必要に応じて構成を編集します。4. [ファイル] > [保存] を選択する、または ⌘+S キーを押して、編集内容を保存します。

次の例では、暗号化された KVM mykvm が定義されています。

[
  {
    "name": "mykvm",
    "encrypted": true
  }
]

Apigee Emulator へのテストリソースのエクスポート

テストリソースを Apigee Emulator にエクスポートするには:

1. エクスポートするテストバンドルにカーソルを合わせて、 をクリックします。

   

2. 複数の Apigee Emulator のコンテナが実行されている場合は、環境をデプロイするコンテナを選択します。

次の図のように、アクティブ テストリソースが Apigee Emulator に表示されます。

自動的に生成され、デベロッパー アプリのテストリソースに含まれるテスト用の API キーなどの特定のリソース情報を取得するために、テスト リソース コンテンツを表示します。

次のステップ

次に、環境にデプロイする。