ステップ 4: API をテストする

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

Apigee Edge のドキュメントを表示します。

デプロイした helloworld API をテストするには、Apigee in Cloud Code の [Terminal] タブをクリックし、次の curl 呼び出しを入力します。

curl 0:8998/helloworld

次のエラー メッセージが表示されます。

ターミナルタブでの API の呼び出しと認証エラー

API プロキシの作成時に API キーベースの認証を有効にしたため、API を呼び出すときに apikey クエリ パラメータを使用して API キーを渡す必要があります。

API キーを取得するには、テストバンドルを作成し、次のテストリソースを構成する必要があります。

  • API をバンドルしてデベロッパーが使用できるようにするために使用する API プロダクト

  • API にアクセスするアプリを作成するデベロッパー

  • API キーを使用して API にアクセスできるようにするデベロッパー アプリ

テストリソースをビルドしてエクスポートする

  1. テストバンドルを作成します。
    1. tests フォルダにカーソルを合わせ、[Create test bundle] アイコン をクリックします。

      tests フォルダにカーソルを合わせると + が表示される

      [Create test bundle] ウィザードが開きます。

    2. テストバンドル名として「mytestbundle」と入力し、Enter キーを押します。

      テストバンドルが作成されます。

    3. mytestbundle フォルダを開いて内容を表示します。

      developerapps.json、developers.json、maps.json、products.json のファイルを含む tests フォルダ

  2. API プロダクトのテストリソースを構成します。
    1. [products.json] ファイルにカーソルを合わせ、[Create API product] アイコン をクリックします。

      products.json にカーソルを合わせると + が表示される

      [Create API product] ウィザードが開きます。

      [Create API product] ウィザードの最初のページ

    2. API プロダクトの名前として「myproduct」と入力し、Enter キーを押して確定してから、次に進みます。
    3. API プロダクトの説明として「myproduct」と入力し、Enter キーを押して確定してから、次に進みます。
    4. [helloworld] を選択して API プロダクトに API プロキシを追加し、[OK] をクリックします。

      新しい API プロダクトが構成されて products.json ファイルがエディタで開きます。

      [
        {
          "attributes": [
            {
              "name": "sample_attribute_0",
              "value": "sample_attribute_value_0"
            }
          ],
          "scopes": [],
          "environments": [],
          "apiResources": [
            "/",
            "/*",
            "/**"
          ],
          "quota": "100",
          "quotaInterval": "1",
          "quotaTimeUnit": "minute",
          "name": "myproduct",
          "displayName": "myproduct",
          "proxies": [
            "helloworld"
          ]
        }
      ]
  3. デベロッパー テストリソースを構成します。
    1. developers.json ファイルにカーソルを合わせ、[Create Apigee developer] アイコン をクリックします。

      developers.json にカーソルを合わせると + が表示される

      [Create developer] ウィザードが開きます。

      [Create API product] ウィザードの最初のページ

    2. プロンプトで次の値を入力し、Enter キーを押して確定してから次に進みます。
      • デベロッパーのメールアドレス: ahamilton@example.com
      • ユーザー名: ahamilton
      • 名: Alex
      • 姓: Hamilton

      新しいデベロッパーが構成されて developers.json ファイルがエディタで開きます。

      [
          {
            "attributes": [
              {
                "name": "sample_attribute_0",
                "value": "sample_attribute_value_0"
              }
            ],
            "email": "ahamilton@example.com",
            "userName": "ahamilton",
            "firstName": "Alex",
            "lastName": "Hamilton"
          }
        ]
  4. デベロッパー アプリのテストリソースを構成します。
    1. developerapps.json ファイルにカーソルを合わせ、[Create developer app] アイコン をクリックします。

      developerapps.json にカーソルを合わせると + が表示される

      [Create developer app] ウィザードが開きます。

      [Create API product] ウィザードの最初のページ

    2. アプリのオーナーとして [ahamilton@example.com] を選択します。
    3. 次のプロンプト セットで次の値を入力し、Enter キーを押して確定してから、次に進みます。
      • アプリ名: myapp
      • 説明: myapp
      • コールバック URL: 空欄
      • [myproduct] を選択してアプリに追加し、[OK] をクリックします。
      • 有効期限に [never] を選択します。

      新しいアプリが構成されて developerapps.json ファイルがエディタで開きます。

      [
        {
          "attributes": [
            {
              "name": "sample_attribute_0",
              "value": "sample_attribute_value_0"
            }
          ],
          "developerEmail": "ahamilton@example.com",
          "name": "myapp",
          "displayName": "myapp",
          "callbackUrl": "",
          "apiProducts": [
            "myproduct"
          ],
          "expiryType": "never"
        }
      ]
  5. テストリソースを Apigee Emulator にエクスポートします。

    mytestbundle テストバンドルにカーソルを合わせ、[Export test resources] アイコン をクリックします。

    API プロダクト、デベロッパー、デベロッパー アプリなどのアクティブなテストリソース

    次の図に示すように、アクティブなテストリソースは [Apigee Emulators] セクションに表示されます。

    API プロダクト、デベロッパー、デベロッパー アプリなどのアクティブなテストリソース

API キーを取得する

デベロッパー アプリの API キー認証情報を取得します。

  1. [emulators] セクションの [Active test data] で、[Active developer apps] をクリックします。

    アクティブ デベロッパー アプリの構成ファイルがエディタで開きます。次の図でハイライト表示しているように、このファイルには myproduct の認証情報が含まれています。

    <p><img src="/apigee/docs/api-platform/images/vscode-consumerkey.png" alt="Developer apps with the consumerKey value highlighted."></p>
    

  2. myproduct API プロダクトの consumerKey 値(引用符なし)をコピーします。

API をテストする

API キーを使用して API をテストします。

  1. 以下のように apikey クエリ パラメータを使用して、curl 呼び出しで API キーを渡します。
    curl 0:8998/helloworld?apikey=API_KEY

    以下のようなレスポンスが返されます。

    Hello, Guest!

お疲れ様でした!ローカル環境で API が正常に実行されました。

次のステップでは、ターゲット エンドポイントを変更する方法を学習します。

1 2 3 4 (次へ)ステップ 5: ターゲット エンドポイントを変更する 6 7 8