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 プロキシについて

Apigee Edge では、アプリ開発者による利用が可能な RESTful API を簡単かつ迅速に構築できます。バックエンドサービスにとって管理された「ファサード」としての役割を果たす API プロキシを構築することで、Edge で API をエクスポーズします。このトピックでは、Apigee Edge における API とAPI プロキシの関係について説明します。

ビデオ: API プロキシの概要については、この短いビデオをご覧ください。

API とは?

API とは、他のアプリケーションの機能やデータを「使用」しやすくするアーキテクチャーです。API は、アプリケーションのロジックやデータへの変わらぬシンプルなエントリポイントを定義して、他のデベロッパによって構築されたアプリケーションロジックへのアクセスやそれらの再利用を簡単にします。「Web API」の場合は、ロジックやデータがネットワーク経由で公開されます。

API を使用するアプリケーションは変更に敏感なので、API は「契約」も含意します。この契約は、API が時間の経過とともに予想のつくやり方で変わることをある程度保証します。

Apigee Edge では、管理階層や表示階層を追加しながら、API を構築できます。また、すでに API を所有している場合は、直接公開することができます。SOA ベースの Web サービスなど、HTTP 対応サービスを使用している場合、Apigee Edge 経由で API として公開することも可能です。

また Edge では、API サービスプラットフォームでホストされているアプリケーションを実装することで、バックエンドサービスなしで API を構築できます。これらのアプリケーションは、JavaScript、Java、Node.js で構築できます。

Apigee では、API そのものや、API の開発および使用のベストプラクティスについて、豊富な情報を提供しています。手始めとして、Web キャスト「API Design」を見たり、無料の電子ブック『Web API Design: Crafting Interfaces that Developers Love』をダウンロードしたりしてください。 

API プロキシとは?

Apigee Edge で API を公開するには、API プロキシを実装します。API プロキシは、アプリ側の API をバックエンドサービスから分離して、これらのアプリをバックエンドコードの変更から遮断します。バックエンドの変更をサービスに適用するときでも、アプリは中断されることなく同じ API の呼び出しを続けます。

API プロキシ構成には、2 つのタイプのエンドポイントがあります。 

  • ProxyEndpoint: クライアントアプリが API を使用する方法を定義します。ProxyEndpoint を構成して、API プロキシの URL を定義します。またプロキシエンドポイントは、アプリが HTTP と HTTPS のどちらで API プロキシにアクセスするかを決定します。通常、ポリシーを ProxyEndpoint に添付して、セキュリティ、クォータチェック、その他のタイプのアクセス制御、レート制限を強制します。
  • TargetEndpoint: API プロキシがバックエンドサービスと連携動作する方法を定義します。セキュリティ設定、HTTP または HTTPS プロトコル、その他の接続情報の定義など、リクエストが適切なバックエンドサービスに転送されるように、TargetEndpoint を構成します。最初のリクエストを作成したアプリに対して、レスポンスメッセージが必ず正しい形式になるように、TargetEndpoint にポリシーを添付できます。

以下の図に示すように、API プロキシを可視化することができます。 

API プロキシの作成方法

API プロキシは、XML 構成ファイルとコード (JavaScript、Java など) のバンドルで構成されています。Apigee では、以下のようにいくつかの方法で API プロキシを作成できます。

  • Edge 管理 UI を使用して、GUI (Graphical User Interface) で API プロキシを定義します。詳細については、「シンプルな API プロキシの構築」を参照してください。
  • その他のサポートファイルとともに、API プロキシを定義する XML ファイルを作成し、Edge にインポートします。
  • Edge 管理 API を使用して、Edge 向けに一連の REST リクエストを作成することで API プロキシを作成します。 
  • Node.js アプリケーションをプロキシとして展開します。「スタンドアロン Node.js アプリの展開」を参照してください。

ポリシーとは?

Edge では、「ポリシー」を使用することで、コードの記述なしで API の動作を制御できます。ポリシーは、プロキシリクエスト/レスポンスフローの一環として特定の限定的な管理機能を実装するモジュールに似ています。ポリシーは、高い信頼性を維持しながら、一般的なタイプの管理機能を API に簡単に追加できるように設計されています。ポリシーには、セキュリティ、レート制限、変換、仲介機能などの機能が備わっています。したがって、独自の環境でこれらの機能をコーディング、保守する必要がありません。  

初めての API プロキシの作成

Apigee は、初めての API を作成するために使用できるチュートリアルのセットを提供しています。「初めての API プロキシの作成」から始めましょう。 

API プロキシを知るための優れた方法は、「Using the sample API proxies」で説明されているサンプルを使ってみることです。 

参考資料

Help or comments?