API プロキシの編集（プロキシリビジョンの作成）

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

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

Apigee UI または API を使用して API プロキシを編集します。API プロキシを編集する場合は、変更結果に応じて次のいずれを行うかを判断できます。

サーバーに変更を保存しますが、新しいリビジョンを作成しません。これは、保存した変更をデプロイしないものの、セッションを終了しても変更が失われないようにする場合に行います。

または
新しい API プロキシリビジョンを作成して、クラスタにデプロイします。API プロキシの新しいリビジョンを作成せずに、API プロキシに変更をデプロイすることはできません。

新しいプロキシエディタ

新しいプロキシエディタを使用して API プロキシの編集と変更の保存を行うには、次の操作を行います。

Cloud コンソールの Apigee UI を使用している場合: [プロキシ開発] > [API プロキシ] を選択します。

従来の Apigee UI を使用している場合: [Develop] > [API Proxies] を選択して、[Proxies] ペインでプロキシの環境を選択します。
プロキシの一覧から編集するプロキシを選択します。Apigee UI により、プロキシに関する [Overview] タブがプロキシエディタに表示されます。
[Develop] タブをクリックします。
プロキシエディタを使用して、プロキシを変更します。変更が完了したら、次のいずれかを行います。
- 新しいリビジョンを作成せずに変更を保存するには、[保存] ボタンをクリックします（これは、セッションを終了しても変更内容が失われないようにするため、定期的に行う必要があります）。
- 変更を新しいリビジョンとして保存するには（デプロイとテストの準備ができている場合）、[保存] ボタンの横にあるプルダウンメニューをクリックして [Save as new revision] を選択します。
  
  Apigee UI により変更が保存され、プロキシの新しいリビジョンが生成されます。新しいバンドルはランタイムにデプロイされません。API プロキシのデプロイで説明されているように、明示的にデプロイする必要があります。

従来のプロキシエディタ

従来のプロキシエディタを使用して API プロキシの編集と変更の保存を行うには、次の操作を行います。

Apigee UI にログインします。
メインビューで [API Proxies] をクリックします。
または、左側のナビゲーションメニューで [Develop] > [API Proxies] を選択することもできます。
編集するプロキシを含む環境を選択します。

Apigee UI に、選択した環境の API プロキシのリストが表示されます。
編集するプロキシをクリックします。Apigee UI により、プロキシに関する [Overview] タブがプロキシエディタに表示されます。
ビューの右上にある [Develop] タブをクリックします。
プロキシエディタを使用して、プロキシを変更します。変更が完了したら、次のいずれかを行います。
- 変更は保存しますが、新しいリビジョンは作成ません（最も一般的です。これは、セッションを終了しても変更内容が失われないようにするため、定期的に行う必要があります）。
- 変更を新しいリビジョンとして保存します（デプロイとテストの準備ができている場合）。
新しいリビジョンを作成せずに保存するには: UI の右上にある [保存] をクリックします。

Apigee UI により変更が保存され、ページを離れても、後で作業を再開できます。
新しいリビジョンとして変更を保存するには: [保存] ボタンの横にあるプルダウン矢印をクリックし、[Save as new revision] を選択します。

Apigee UI により変更が保存され、新しいプロキシバンドルが生成されます。新しいバンドルはランタイムにデプロイされません。API プロキシのデプロイで説明されているように、明示的にデプロイする必要があります。
「New revision saved」というメッセージが表示されます。

新しいリビジョンを作成したら、通常は API プロキシのデプロイの説明に沿って、クラスタにデプロイします。

Apigee API

次のリソースに POST リクエストを発行して、API プロキシを編集し、Apigee 組織にリビジョンを作成します。

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 プロキシを編集する方法を示しています。

export TOKEN=$(gcloud auth print-access-token)
export ORG=ORGANIZATION_NAME
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 プロキシの編集（プロキシ リビジョンの作成）

新しいプロキシ エディタ

従来のプロキシ エディタ

Apigee API

API プロキシの編集（プロキシリビジョンの作成）

新しいプロキシエディタ

従来のプロキシエディタ