サンプル API プロキシの使用

前提条件

http://enterprise.apigee.com のアカウントが必要です。http://accounts.apigee.com/accounts/sign_up で試用アカウントを取得できます。

サンプルを使用するには以下のものも必要です。

ツール 説明
Git サンプルは GitHub にあります。Git をインストールしていない場合は、GitHub の git のセットアップ手順をご覧ください。Git をインストールしない場合は、https://github.com/apigee/api-platform-samples でファイルの参照や zip のダウンロードを行うことができます。
Python

Python は Apigee デプロイツールを実行するために必要です。Python は、ほとんどの Linux 環境、XCode がインストールされている Mac、Cygwin がインストールされている Windows マシンなど、あらゆる場所で使用されています。

Python を入手するには、Python のダウンロード ページをご覧ください。
curl サンプルのセットアップ スクリプトでも curl を使用しています。curl がインストールされており、PATH で使用できることを確認します（which curl を実行して、システムで使用できるかどうかを確認します）。
dos2unix Windows で Cygwin を実行している場合は、dos2unix ユーティリティも必要になることがあります（このユーティリティは Cygwin のインストーラでインストールできます）。

サンプルをダウンロードする

サンプル ファイルを取得するには、次の例のように git clone を使用します。

git clone https://github.com/apigee/api-platform-samples.git

サンプル API プロキシをインポートしてデプロイする

以下のコマンドでサンプルのインポートとデプロイを行います。

  1. サンプルをダウンロードしたら、次の例のように /setup ディレクトリに移動します。
    cd setup
  2. /setup ディレクトリで setenv.sh ファイルを探します。
  3. このファイルを編集して、組織、ユーザー名に関連付けられたメールアドレス、デプロイする API プロキシの環境（本番あるいはテスト）を設定します。
  4. setenv.sh を編集したら、次のコマンドを実行します。
    sh deploy_all.sh

    このスクリプトでは、組織に API プロキシのサンプルがすべてデプロイされます（これには 3～4 分かかります）。指示に従って、API プロダクト、デベロッパー、アプリ（OAuth のために使用）をデプロイします。

  5. デプロイ スクリプトの実行が完了したら、sample-proxies ディレクトリに移動します。sample-proxies ディレクトリには、サンプル プロキシごとに 1 つのディレクトリがあります。各ディレクトリには、サンプルの実行手順が書かれた README.md と、小さな変更を加えたサンプルを、デプロイし、実行して変更の結果を確認するためのスクリプトが 2 つあります。
    • invoke.sh: このスクリプトを実行して、デプロイされたバージョンの API プロキシを実行します。
    • deploy.sh: 変更を加えた後、このスクリプトを実行して API プロキシをデプロイします。

サンプル API プロキシを呼び出す

各サンプル プロキシには、デプロイした後でその API プロキシを呼び出すシェル スクリプトがあります。

/sample-proxies/proxy_name ディレクトリから、次のコマンドを実行します。

sh invoke.sh

これにより、組織のテスト環境で実行されているプロキシが呼び出されます。

トラブルシューティング

トラブルシューティングの情報については、以下をご覧ください。

サンプル API プロキシを変更して再利用する

サンプル プロキシの一般的な利用方法は、変更して、デプロイし、呼び出すことです。これにより、小さな変更を加えてレスポンス メッセージにどのような影響があるかを確認できます。

別のバックエンド サービスを参照するようにサンプル API プロキシを変更するには、次の場所にある XML 構成ファイルを変更します。

/apiproxy/targets/target_name.xml

たとえば、API キーのサンプルに独自のバックエンド サービスを指定するには、次のファイルを見つけます。

/apikey/apiproxy/targets/default.xml

デフォルトの構成が http://mocktarget.apigee.net を参照している場合は、次のようになります。

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

バックエンド サービスが http://api.myproject.com/ にある場合は、次のように構成を変更します。

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

変更を保存したら、次の例のように API プロキシをデプロイします。

sh deploy.sh

他の API プロキシは、既存のターゲット サービスに対して API プロキシを使用するために、同じ方法で変更できます。ただし、API プロキシの動作は特定のメッセージ形式に依存するため、プロキシで追加の構成変更が必要な場合があります。