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.

基本用語

以下の概念の中には、一般的なアイデアながら Apigee において独自の意味合いを持っているものがいくつかあります。

用語 定義
API

 「アプリケーションプログラミングインターフェイス」の略で、他のアプリケーションの機能やデータを「使用」しやすくするアーキテクチャです。

API は、アプリケーションのロジックやデータへの変わらぬシンプルなエントリポイントを定義して、他のデベロッパによって構築されたアプリケーションロジックへのアクセスやそれらの再利用を簡単にします。「Web API」の場合は、ロジックやデータがネットワーク経由で公開されます。API を使用するアプリケーションは変更に敏感なので、API は「契約」も含意します。この契約は、API が時間の経過とともに予想のつくやり方で変わることをある程度保証します。

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

API プロキシ

1 つまたは複数の API、各種汎用 HTTP サービス、またはアプリケーション (Node.js など) への、Edge に用意されたファサードです。

API プロキシは、Apigee Edge によって提供されるリソースセットに依存する構成ファイル、ポリシー、コードの一式として実装されます。API プロキシは、Apigee Edge 管理 UI を使用して生成または構成したり、テキストエディタや IDE でローカルに実装したりできます。

API プロキシが提供するファサードは、デベロッパが相対する API を「バックエンド」サービスから切り離すことで、内部デベロッパチームに影響を与えずにデベロッパをコード変更から守り、最先端のイノベーションを可能にします。開発チームがバックエンド変更を行っても、デベロッパは何の妨げもなく同じインターフェイスを引き続き呼び出せます。Apigee を採用することで、複数のインターフェイスを同じ API に公開でき、API シグネチャーを自由にカスタマイズして、さまざまなデベロッパニッチを同時に満たすことができます。

API のベースパスとリソース

ネットワークアドレスと URI で定義される API です。 API は、「ベースパス」と、「API リソース」のセットとで構成されます。各 API プロキシは、ベースパスと、任意で複数の API リソースパスを定義できます。API は単純に、すべてで共通のベースパスを使用する URI の集合と考えられます。

API を管理しやすくするため、Apigee ではこれらの URI に表示名と説明を付加しています。Edge を使用すると、URI にポリシーやコードを添付して、API の動作を細かく管理できます。

API 製品

API リソースのコレクション (URI) にクォータないし「サービスプラン」を組み合わせたもので、設計時にアプリデベロッパに公開されます。API 製品 (product) は、マネタイズを目的として API パッケージとしてバンドル化できます。

API キーは 1 つまたは複数の API 製品にバインドされ、アプリとアプリでの使用が許可された一連の URI とのバインドを強制します。

API パッケージ デベロッパにバンドルとして提示される API 製品の集合で、一般に、マネタイズ機能に定義された料金プランと関連付けられます。
アプリ

「アプリケーション」の略語です。「アプリ」という用語は、API を使用するモバイルアプリケーションを指すようになりました。 デベロッパはアプリを各種プログラミング言語で実装し、その際、さまざまな技術やプラットフォームを用います。API の使用を望むデベロッパは、Apigee Edge で API プロバイダの組織 (organization) にアプリを登録します。

アプリが登録されると、そのアプリを識別する API キーとシークレットが Apigee によって生成されます。デベロッパはその API キーをアプリに埋め込み、アプリはリクエストの際のそのキーを提示します。API Services は、直接的な API キー検証や OAuth を通じて、API キーに対するセキュリティ保護を実装します。

環境

API プロキシのランタイム実行コンテキストです。公開する API にネットワーク経由でアクセスできるようにする前に、API プロキシを環境 (environment) に展開する必要があります。デフォルトで、組織には「test」と「prod」という 2 つの環境がプロビジョニングされます。

  • 「test」環境は、通常、開発中に API プロキシを展開するのに使用されます。
  • 「prod」環境は、通常、test 環境での開発とテストが完了した API プロキシを昇格させるのに使用します。
組織

API プロキシ、API 製品、API パッケージ、アプリ、デベロッパなど、Apigee Edge アカウントに含まれるあらゆるオブジェクトのコンテナです。

所属する組織 (organization) ごとにユーザーアカウントが必要です (ほとんどのユーザーは 1 つの組織にしかアカウントを持ちません)。API リクエストを送信するたび、資格情報 (ユーザー名とパスワード) と所属組織名を提示する必要があります。

ポリシー

API プロキシ処理フロー内において、ロジックのアトミックで再利用可能な単位として実行される処理ステップです。

通常、ポリシーベースの機能には、メッセージの形式変換、アクセス制御の強制、追加情報を要求するためのリモートサービスの呼び出し、外部ユーザーに対する機密情報の秘匿、潜在的な脅威を探すためのメッセージ内容の検証、一般的なレスポンスのキャッシュ処理を通じたパフォーマンス向上などがあります。

ポリシーは、リクエストメッセージやレスポンスメッセージの内容やコンテキストに基づき、条件実行できます。例えば、リクエストメッセージがスマートフォンから送信されてきた場合に、変換ポリシーを実行してレスポンスの形式をカスタマイズできます。

API リソースパス RESTful 概念の 1 つで、所定のリソースまでのネットワークパスを指定する URI (統一資源識別子) です。
version

デベロッパに公開されている API インターフェイスのバージョンです。

例えば、pivotaltracker.com/services/v3、または api.enterprise.apigee.com/v1 のように示されます。

この用語と「リビジョン」には使い分けがあります。リビジョンは、構成やポリシーをバンドルして API プロキシにした、バージョン管理された番号付きパッケージを指します。API インターフェイスにはバージョンがあり、API プロキシにはリビジョンがあります。

リビジョン 構成やポリシーをバンドルして API プロキシにした、バージョン管理された番号付きパッケージです。この用語と「バージョン」は使い分けられます。バージョンは、デベロッパに公開されている API インターフェイスを指します。上欄の説明を参照してください。

 

Help or comments?