API プロキシの作成

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

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

以降のセクションで説明するように、Apigee UI または API を使用してプロキシを作成します。

Cloud コンソールの Apigee

Cloud コンソールの Apigee でプロキシを作成するには:

  1. ブラウザで Cloud コンソールの Apigee UI を開きます。
  2. 左側のナビゲーション ペインで、プロキシの開発 > API プロキシをクリックします。
  3. API プロキシ ペインで + 作成をクリックします。
  4. プロキシの作成 ペインで、プロキシ テンプレートリバース プロキシ(最も一般的)を選択します。
  5. プロキシの詳細に次のように入力します。
    • プロキシ名: プロキシの名前を入力します(例: myproxy)。
    • ベースパス: Proxy name に入力する値に自動的に設定されます。ベースパスは、API に対するリクエストを行うために使用される URL の一部です。Apigee では、URL を使用して受信リクエストを照合し、適切な API プロキシに転送します。
    • 説明文(省略可): 新しい API プロキシの説明を(「シンプルなプロキシによる Apigee のテスト」など)入力します。
    • ターゲット(既存の API): https://mocktarget.apigee.netを入力します。 これにより、API プロキシへのリクエストに応じて Apigee が呼び出すターゲット URL が定義されます。mocktarget サービスは Apigee でホストされ、単純なデータを返します。API キーやアクセス トークンは必要ありません。
    • [次へ] をクリックします。
  6. [次へ] をクリックします。
  7. デプロイ(省略可):
    • デプロイ環境: 省略可。チェックボックスを使用して、プロキシをデプロイする環境を 1 つ以上選択します。この時点でプロキシをデプロイしない場合は、デプロイ環境フィールドを空白のままにします。プロキシは、後でいつでもデプロイできます。
    • サービス アカウント: 省略可。サービス アカウントをデプロイに関連付け、サービス アカウントのロールと権限で指定されているように、プロキシが Google Cloud サービスにアクセスできるようします。
  8. [作成] をクリックします。

Apigee によって新しいプロキシが作成され、プロキシ サマリー ビューにプロキシの詳細の要約が表示されます。

myproxy のサマリーペイン

プロキシをデプロイすることを選択した場合、[Deployments] セクションには最初のデプロイ時のリビジョン番号「1」が表示されます。ステータス列には、プロキシがデプロイされている環境が緑色のステータス インジケーターで表示されます。

従来の Apigee

従来の Apigee UI でシンプルな API プロキシを作成するには、次のようにします。

  1. Apigee UI にログインします。
  2. メインビューで API プロキシをクリックします。
  3. 環境プルダウン リストから、新しい API プロキシを作成する環境を選択します。

    ハイブリッド UI に、その環境の API プロキシのリストが表示されます。プロキシをまだ作成していない場合、リストは空です。

  4. [新規作成] をクリックします。

    [Create Proxy] ウィザードが起動します。

  5. リバース プロキシ(最も一般的) をクリックします。

    リバース プロキシ

    [プロキシの詳細] ページが表示されます。

  6. 以下の設定でプロキシを構成します。
    • 名前: getstartedを入力します。この名前のプロキシがすでに存在する場合は、別の名前を選択します。
    • ベースパス:これを /getstarted のままにします。ベースパスは、API に対するリクエストを行うために使用される URL の一部です。Apigee では、URL を使用して受信リクエストを照合し、適切な API プロキシに転送します。
    • 説明(省略可): Get started API proxy など、新しい API プロキシの説明を入力します。
    • ターゲット(既存の API): https://mocktarget.apigee.netを入力します。API プロキシへのリクエストに応じて Apigee が呼び出すターゲット URL を定義します。mocktarget サービスは Apigee でホストされ、単純なデータを返します。API キーやアクセス トークンは必要ありません。

    API プロキシの詳細は、次のようになります。

    API プロキシの詳細

  7. [次へ] をクリックします。
  8. 一般的なポリシー ビューで、セキュリティ: 承認パススルー(承認なし) を選択します。

    パススルーの選択

  9. [次へ] をクリックします。
  10. [サマリー] ページで、必要に応じてデプロイ環境を選択し、作成とデプロイをクリックします。

    作成とデプロイ

    新しい API プロキシが作成されて、選択した環境にデプロイされます。

    デプロイの成功画面

  11. プロキシの編集をクリックして、プロキシ エディタの概要タブを表示します。
  12. プロキシリストの編集

API プロキシのリストで、test 環境の getstarted API プロキシのデプロイ ステータスが緑色になっています。

API プロキシのリストを表示します。getstarted のデプロイ ステータスは緑色です。

Apigee API

Apigee 組織で API プロキシを作成するには、POST リクエストを次のリソースに対して発行します。

https://apigee.googleapis.com/v1/organizations/$ORG/apis

name クエリ パラメータを使用して、API プロキシの名前を定義する必要があります。名前に使用する文字を A-Za-z0-9._\-$ % に制限します。

必要に応じて、次の手順を実行し、API プロキシ構成バンドルをインポートできます。

  • action クエリ パラメータを import に設定します。
  • Content-type ヘッダーを multipart/form-data に設定します。
  • API プロキシ構成バンドルの名前をローカル ファイル システムに渡します。

次の例は、API を使用してローカル ファイル システムに API プロキシ構成バンドル(helloworld-config.zip)をインポートして、API プロキシを作成する方法を示しています。

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis?name=helloworld&action=import" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: multipart/form-data" \
  -F "file=@helloworld-config.zip"

ここで、OAuth 2.0 アクセス トークンの取得で説明されているように、$TOKEN は OAuth 2.0 アクセス トークンに設定されます。この例で使用されている curl オプションの詳細については、curl の使用をご覧ください。使用される環境変数の説明については、Apigee API リクエストの環境変数の設定をご覧ください。

レスポンス出力の例を次に示します。

{
  "basepaths": [
    "/helloworld"
  ],
  "configurationVersion": {
    "majorVersion": 4
  },
  "createdAt": "1559145292799",
  "displayName": "helloworld",
  "entityMetaDataAsProperties": {
    "bundle_type": "zip",
    "subType": "Proxy",
    "lastModifiedAt": "1559145292799",
    "createdAt": "1559145292799"
  },
  "lastModifiedAt": "1559145292799",
  "name": "helloworld",
  "policies": [
    "verify-api-key",
    "remove-query-param-apikey",
    "OAuth-v20-1"
  ],
  "proxies": [
    "default"
  ],
  "proxyEndpoints": [
    "default"
  ],
  "resourceFiles": {},
  "targetEndpoints": [
    "default"
  ],
  "targets": [
    "default"
  ],
  "type": "Application",
  "revision": "1",
  "description": "Hello world"
}

API プロキシの作成の詳細については、Apigee API の apis.create メソッドをご覧ください。API プロキシで使用可能なすべてのメソッドについては、API プロキシ API をご覧ください。

次のステップ

シンプルな API プロキシを作成したら、通常は次のいずれかを行います。