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.

展開について

このトピックでは、プロキシ展開の概要を簡単に説明します。管理 UI、コマンドラインスクリプト、または API でプロキシを展開できます。 

プロキシを展開するタイミング

プロキシは、呼び出しの前に展開する必要があります。通常、展開を行うタイミングはユーザーに任されています。テスト環境で作業を行っている場合、何度でも対話的に展開することができます。一方で、テスト環境から実稼働環境にプロキシを展開するかどうかの判断は、通常、開発チームが定めたライフサイクルルールによって決まります。 

プロキシの展開または再展開は、次のタイミングで実行します。

  • 新しいプロキシの作成時 (展開は自動的に実行されます)
  • 既存プロキシの変更時 
  • プロキシの新しいリビジョンの作成時
  • プロキシの新しいバージョンの作成時
  • テスト環境から実稼働環境に移行するなど、環境間でのプロキシの移行時 
  • キーストアの削除および再作成の実行時

プロキシを展開する場所

プロキシを環境 (environment) に展開します。Apigee Edge のどの組織 (organization) にも、デフォルトで「test」と「prod」の 2 つの環境があります。要は、これらの環境は API 変更の作業およびテストの場と API をアプリに公開する場を提供するためのものです。次の図では、test 環境に展開されるプロキシを緑色の丸で示します。 

ロールによっては、一部の環境に展開できないことがあります。ユーザーは test 環境のみに展開できます。管理者の場合は、すべての環境に展開できます。

プロキシを展開する方法

プロキシの展開方法は、プロキシを開発している場所によって異なります。UI で作業している場合、数回のマウスクリックのみで簡単にプロキシを展開できます。新しいプロキシは作成時に自動的に展開されます。特別な操作は不要です。既存のプロキシを再展開する手順はシンプルです。展開先にする環境を選択するだけで、それ以降の操作は管理 UI によって実行されます。詳細については、「UI でのプロキシの展開」を参照してください。

プロキシと関連コンポーネントをオフラインで開発している場合 (つまり、プロキシ XML ファイルとその他のコードをファイルシステムで直接操作する場合)、Apigee Edge では、便利なコマンドライン展開ツールを使用できます。またプロキシファイルのアップロードと展開のために、構成して実行できるサンプルシェルスクリプトを入手できます。詳細については、「コマンドラインでのプロキシの展開」を参照してください。

最後に、Edge 管理 API を使用してプロキシを展開できます。展開 API は、API 開発ライフサイクルの自動化と最適化のために開発チームが調整できる最小単位の機能を公開します。「管理 API を使用した API プロキシの展開」を参照してください。

API プロキシのリビジョンとは?

リビジョンでは、API プロキシを作成して環境に展開するときに、API プロキシの更新を管理できます。リビジョンには順番に番号が振られており、API プロキシの以前のリビジョンを展開することで、変更を元に戻すことができます。リビジョンが同じ API プロキシベースパスを共有している場合、一度に 1 つの環境に展開できる API プロキシのリビジョンは 1 つだけです。ただし、ベースパスを変更することで、API プロキシの複数のバージョンを同じ環境に展開できます。詳細については、「UI でのプロキシの展開」を参照してください。

通常、新しいリビジョンを展開する前に、既存のリビジョンの展開を解除する必要があります。その他の高度なオプションには、展開されたリビジョンを上書きするオプション、リビジョンの増分をまったく行わないオプションなどがあります。例えば、小さな変更を行ったが、リビジョンの増分は望ましくないと考えられるような場合です。これらの高度なオプションは、Edge 管理 API の直接呼び出しで実行できます。「管理 API を使用した API プロキシの展開」を参照してください。

API プロキシのあるリビジョンを prod 環境に展開する一方で、その API プロキシの新たなリビジョンの作成を test 環境で継続することができます。用意が整ったら、リビジョンの高い API プロキシを test 環境から「昇格」させて、prod 環境にある以前のリビジョンを上書きできます。

リビジョンの詳細については、「管理 API を使用した API プロキシの展開」と「UI でのプロキシの展開」を参照してください。

Best practices for API versioning

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

 

Help or comments?