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 プロキシの作成

学習内容

このチュートリアルでは、以下のことを学びます。

  • API プロキシを作成します。
  • リクエストを既存の RESTful ターゲットサーバーに送信するように API プロキシを構成します。
  • cURL を使用して API プロキシを呼び出します。

このチュートリアルでは、Apigee Edge 管理 UI を使用して、シンプルな API プロキシを作成し、設定するプロセスについて説明します。

これから作成する API プロキシは、「Hello World」です。HTTP クライアントで API プロキシを呼び出すと (ここでは、端末ウィンドウで cURL ツールを使用)、API プロキシにより、リクエストが既存のターゲットサービスに送信され、そのサービスからレスポンスでテキストが返されます。

必要なもの

  • Apigee Edge アカウント。まだ持っていない場合は、「Apigee Edge アカウントの作成」の指示に従ってサインアップできます。
  • cURL installed on your machine to make API calls from the command line; or a web browser.

API プロキシの作成

About the 'mocktarget'

The mocktarget service is hosted at Apigee and returns simple data. It requires no API key or access token. In fact, you can access it in a web browser. Try it out by clicking the following:

http://mocktarget.apigee.net

In the browser and in the test API call you'll make later, the target returns Hello, Guest!. Use the /help resource to get a help page of other API resources that are available.

  1. Go to https://apigee.com/edge and log in. This is the New Edge experience UI. (You could also use the classic management UI, which has slightly different navigation. Both UIs create the proxy in your organization.)
  2. Change to the organization you want. In the upper left, click your username, then click the name of the current organization to select from a list of organizations.
  3. Click API Proxies in the main window. This gives you a list of existing API proxies.

    Note: In the list of API proxies, you may already have one named helloworld. You can either delete this proxy and continue with the tutorial, or give the proxy in this tutorial a different name.

  4. 追加用の「(+) API Proxy」ボタンをクリックします。
  5. 「Build a Proxy」ウィザードで、「Reverse proxy (most common)」を選択し、「Next」をクリックします。
  6. 以下に従ってプロキシを構成します。
    フィールド 操作内容
    Proxy Name

    次のように入力します: helloworld

    If a proxy already exists with this name, just enter a different name, such as helloworld_tutorial.

    Proxy Base Path

    Change to: /hello

    The Proxy Base Path is part of the URL used to make requests to your API. Apigee Edge uses the URL to match and route incoming requests to the proper API proxy.

    Note: For Apigee's recommendations on API versioning, see Versioning in the Web API Design: The Missing Link e-book.

    Existing API

    次のように入力します: http://mocktarget.apigee.net

    Be sure to use http and not https. This defines the target URL that Apigee Edge invokes on a request to the API proxy.

    説明 次のように入力します: hello world proxy

  7. 「Next」をクリックします。
  8. 「Security」ページで、セキュリティオプションとして「Pass through (none)」を選択し、「Next」をクリックします。
  9. 「Virtual Hosts」ページで、「Next」をクリックします。
  10. 「Build」ページで、test 環境が選択されていることを確認し、「Build and Deploy」をクリックします。
  11. 「Summary」ページで、新しい API プロキシが正常に作成され、test 環境に展開されたことを示す確認応答が表示されます。
  12. Click View helloworld proxy in the editor to display the Overview page for the API proxy.

おめでとうございます! シンプルな API プロキシを作成できました。次に、その動作をテストします。

API プロキシのテスト

You can test your helloworld API using cURL or a web browser.

In a terminal window, run the following cURL command. Substitute your organization name in the URL.

You can also enter the URL portion in a web browser to get a similar response.

curl http://<org_name>-test.apigee.net/hello

レスポンス

You should see the following:

Hello, Guest!

Remember that when you created your API proxy, you configured it to send the request to the "Existing API" of http://mocktarget.apigee.net. So at this point, cURLing your new API proxy (http://<org_name>-test.apigee.net/hello) is the same as cURLing http://mocktarget.apigee.net. In later tutorials, you'll see how adding policies to your API proxy changes its behavior.

よくできました。シンプルな API プロキシを構築し、テストしました。

 

Help or comments?