Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

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

Apigee provides a set of samples on GitHub that you can download and run locally. For a list of samples, see Samples reference.

The setup README in the samples also contains the information in this topic.


You'll need an account on You can sign up for a trial account at

アカウントの作成の詳細については、「Apigee Edge アカウントの作成」を参照してください。

To use samples, you should also have the following:

Tool 説明
Git GitHub に配置されているサンプルです。Git をインストールしていない場合は、GitHub の git のセットアップ手順を参照してください。Git のインストールを希望しない場合は、 でファイルを参照したり、zip をダウンロードしたりすることができます。

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

Python を入手するには、Python のダウンロードページを参照してください。 

cURL The sample setup scripts also use cURL. Make sure cURL is installed and available on your PATH (run the which curl command to see if it's available on your system).
dos2unix If you're running Cygwin on Windows, you may also need the doc2unix utility. (The Cygwin installer lets you install the utility.) See the Windows/Cygwin Troubleshooting topic for more information.

Downloading the samples


$ git clone

Importing and deploying the sample API proxies

Import and deploy the samples from the command line:

  1. After you download the samples, go to the /setup directory.
    $ cd setup
  2. In the /setup directory, locate the file Edit this file to set your organization, the email address associated with your username, and the environment (prod or test) where you want to deploy the API proxies.  
  3. After you edit, run:
    $ sh
    このスクリプトでは、組織に API プロキシのサンプルがすべて展開されます (このプロセスには 3~4 分かかります)。 API 製品 (product)、デベロッパ、およびアプリ (OAuth のために使用) を展開するように求めるプロンプトに従います。  
  4. 展開スクリプトの実行が完了したら、sample-proxies ディレクトリに移動します。sample-proxies ディレクトリには、サンプルプロキシごとに 1 つのディレクトリがあります。各ディレクトリには、サンプルの実行に関する情報が格納されている ファイルと、次の 2 つのスクリプトがあります。これらのサンプルは、少し変更を加えて展開した後、そのサンプルを呼び出して、変更が反映されていることを確認する場合に役立ちます。
    • このスクリプトは、API プロキシの展開済みのバージョンを呼び出すために実行します。
    • Run this script to deploy the API proxy after you make any changes.

Invoking the sample API proxies

Each sample proxy has an associated shell script that can be used to invoke the API proxy after you deploy it.

From the /sample-proxies/{proxy_name} directory, run:

$ sh

This will invoke the proxy that is running in the test environment in your organization.


If you run into issue with the sample, see Troubleshooting. The topic includes a Windows/Cygwin Troubleshooting section for fixing deployment errors in Cygwin on Windows.

Modifying and reusing the sample API proxies

Typical usage of the sample proxies is to modify, deploy, and invoke. This enables you to make small modifications, and then to see what effect they have on the response message.

If you need to modify a sample API proxy to point at a different backend service, modify the XML configuration file under:


For example, to point the API key sample at your own backend service, locate this file:


If the default configuration points to, such as:

<TargetEndpoint name="default">
    <!-- This is where we define the target. For this sample we just use a simple URL. -->

and your backend service is available at, then you modify the configuration to look like the following:

<TargetEndpoint name="default">
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
After you have saved your changes, deploy the API proxy:
$ sh

The other API proxies can be modified the same way in order to use the API proxy functionality against your existing target services. In some cases, however, API proxy behavior is dependent on specific message formats, so the proxies might need additional configuration changes.

Help or comments?