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

要件

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

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

ツール 説明
Git サンプルは GitHub にあります。Git をインストールしていない場合、git の設定手順(GitHub)をご覧ください。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 Cygwin on Windows で使う場合、dos2unix ユーティリティも必要です(Cygwin のインストーラでインストールできます)。詳細については、Windows/Cygwin のトラブルシューティングのトピックをご覧ください。

サンプルのダウンロード

サンプル ファイルを入手するには、次のコマンドを実行します。

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

サンプル API プロキシのインポートとデプロイ

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

  1. サンプルをダウンロードしたら、/setup ディレクトリに移動します。
        cd setup
        
  2. /setup ディレクトリで、ファイル setenv.sh を見つけます。このファイルを編集して、組織、ユーザー名に関連付けられたメールアドレス、デプロイしたい API プロキシの環境(本番あるいはテスト)を設定します。
  3. setenv.sh を編集した後で、次を実行します。
        sh deploy_all.sh
        
    このスクリプトでは、組織に API プロキシのサンプルがすべてデプロイされます(これには 3~4 分かかります)。指示に従って、API プロダクト、デベロッパー、アプリ(OAuth のために使用)をデプロイします。
  4. デプロイ スクリプトの実行が完了したら、sample-proxies ディレクトリに移動します。ディレクトリ sample-proxies に、サンプル プロキシごとにディレクトリが 1 つずつできています。各ディレクトリには、サンプルの実行手順が書かれた README.md と、小さな変更を加えたサンプルを、デプロイし、実行して変更の結果を確認するためのスクリプトが 2 つあります。
    • invoke.sh: このスクリプトで、デプロイされたバージョンの API プロキシを実行します。
    • deploy.sh: 変更を加えた後、このスクリプトで API プロキシを実行します。

サンプル API プロキシの呼び出し

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

/sample-proxies/{proxy_name} ディレクトリから次のように実行します。

    sh invoke.sh
    

これによって、組織内のテスト環境でプロキシが呼び出されます。

困ったときに

サンプルで問題が発生したときには、問題解決の概要をご覧ください。このトピックには、Windows 上の Cygwin でのデプロイエラーを解決するための Windows/Cygwin の問題解決が含まれています。

サンプル 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 プロキシの動作は特定のメッセージ形式に依存するため、プロキシで追加の構成変更が必要な場合があります。