API Connect のコンポーネント

Cloud Manager

Cloud Manager について詳しくは、クラウドの管理を参照してください。

デベロッパーズ・ツールキット

デベロッパーズ・ツールキットは、API および LoopBack アプリケーションのモデル化、開発、テストに使用するツールを提供します。デベロッパーズ・ツールキットには、コマンド・ライン・インターフェース (CLI) と、これに対応するグラフィカル・ユーザー・インターフェースとして API Designer が含まれています。また、オープン・ソースの Node.js フレームワークである LoopBack を統合します。

API 開発者は、API Designer の API 管理機能または CLI を使用して、REST API や SOAP API 向け、または OAuth 2.0 認証で使用される OAuth プロバイダー・エンドポイント向けにドラフト API 定義を作成します。この API 定義を構成することで、API の製品への追加や、(要求/応答を操作する) ポリシー・アセンブリー・フローの追加、およびセキュリティー・オプションやその他の設定の定義を行えます。さらに、API を公開する前にローカルでテストして、API が正しく定義および実装されていることを確認できます。

API 開発者は、LoopBack を使用してモデル定義を作成することで、Node.js アプリケーションを作成してデータ・ソース (バックエンド・データベース、または使用する REST API など) に接続し、そのアプリケーションを REST API として公開できます。LoopBack モデルは、API のアプリケーション・データ、検証ルール、データ・アクセス機能、およびビジネス・ロジックを定義し、デフォルトで REST API を提供します。この REST API を、API Designer または CLI を使用して作成された REST API 定義で使用して、ユーザーに公開できます。プロジェクトを実行可能にするためには、LoopBack プロジェクトとして実装される API およびその API に関連付けられたアプリケーションの両方を公開する必要があります。LoopBack プロジェクトもローカルでテストできます。以下の図に、LoopBack プロジェクトのアーキテクチャーを示します。

API Designer、CLI、または LoopBack を使用して作成されたドラフト API (その API を含む製品) は、いずれもカタログに公開されます。LoopBack を使用して作成されたアプリケーションは、コンテナーまたは API Connect Collective に公開され、呼び出されるとそこから実行されます。(コンテナーおよび API Connect Collective については、アプリケーション・ランタイム/コンテナー化ランタイム/API Connect Collectiveを参照してください)。

API Designer、CLI、または LoopBack を使用して作成されたドラフト API (その API を含む製品) は、いずれもカタログに公開されます。LoopBack を使用して作成されたアプリケーションは、API Connect Collective に公開され、呼び出されるとそこから実行されます。(API Connect Collective は、単独でインストール可能な API Connect のコンポーネントです。詳しくは、アプリケーション・ランタイム/コンテナー化ランタイム/API Connect Collectiveを参照してください)。

オフラインでの API およびアプリケーションの開発に対応するために、デベロッパーズ・ツールキットはローカルにインストールされます。デベロッパーズ・ツールキットについて詳しくは、API およびアプリケーションの開発を参照してください。LoopBack について詳しくは、 「LoopBack: The Node.js API Framework」を参照してください。

API Manager

API Manager は、製品内やプラン内にパッケージ化された API のプロモーションおよび追跡を容易にするユーザー・インターフェースを提供します。API プロバイダーは、ライフサイクルを通して製品の状態を移行させたり、API とプランの可用性および可視性を管理したりできます。

カタログとスペースは、API Manager 内で作成され、API、プラン、製品を開発者組織に公開する際に使用されるステージング・ターゲットとして機能します。API プロバイダーは、製品をカタログまたはスペースにステージングした後に公開することで、これらの製品に含まれる API を、外部ディスカバリー用に開発者ポータル上で表示できるようにします。

使用可能な API 管理機能へのアクセスを制御するために、プロバイダー組織のユーザーを API Manager の UI でセットアップして、ロールと権限を割り当てることができます。API プロバイダーもこの UI を使用して、API やプランにアクセスするためにサインアップした開発者組織を管理できます。 特定の製品とプランのセットを利用可能にする開発者組織の集合をグループ化する手段として、開発者コミュニティー を作成することもできます。

さらに、API Manager の UI には API 環境のセキュリティーを管理するための機能が組み込まれており、カスタマイズ可能なダッシュボード・ビュー内で API 呼び出しメトリックに関する分析情報にアクセスできます。

API Managerについて詳しくは、API の管理を参照してください。

API ゲートウェイ

API Connect オファリング (またはエディション) には、Micro Gateway のみを含めることも、 Micro Gateway と仮想 DataPower Gateway の両方を含めることもできます。 特定の条件下では、物理 DataPower Gateway もサポートされます。API Connect オファリングについて詳しくは、API Connect オファリングを参照してください。

アプリケーション・ランタイム/コンテナー化ランタイム/API Connect Collective

アプリケーションおよび API 実装を API Connect Collective () またはアプリケーション・コンテナーで実行できます。

注: API Connect Collective は API Connect V5.0.7 で非推奨となっています。

アプリケーション・ランタイム

アプリケーション・ランタイム は、API Connect 内の API を実行するためのランタイム環境を提供します。

コンテナー化ランタイム

コンテナー化ランタイム環境は、API とアプリケーションの軽量のデプロイメント先となります。コンテナーは、アプリケーションを実行するために必要なすべてのもの (コード、ランタイム、システム・ツール、システム・ライブラリーなど) を備えた完全なファイル・システム内にアプリケーションをラップします。API Connect で管理されている API およびアプリケーションは、Docker Swarm または Kubernetes コンテナーを使用して実行できます。詳しくは、コンテナー化ランタイム環境のインストールを参照してください。

API Connect Collective

オンプレミス環境では、API Connect Collective コンポーネントはさらに、デベロッパーズ・ツールキットを使用して作成された LoopBack アプリケーションを実行するための一連のランタイム環境を提供します。

API Connectでは、API Connect Collective を使用して、LoopBack アプリケーションおよび Micro Gateway (これ自体が LoopBack アプリケーションとして作成されています) をデプロイして実行します。API Connect Collective は、サーバーの集合を対象とした管理および運用ドメインです。このコンテキストでのサーバー とは、API Connect Collective にデプロイするアプリケーション・サーバーとしてパッケージ化された LoopBack アプリケーションを指します。LoopBack アプリケーション (サーバー) を API Connect Collective に公開する際は、アプリケーション・サーバーを API Connect Collective に参加 させる必要があります。これにより、そのアプリケーション・サーバーは Collective メンバー になります。Collective メンバーとは、デプロイ済みアプリケーションのランタイムのことです。各デプロイ済みアプリケーションの Collective メンバーは、メンバー・ホスト 上で稼働します。メンバー・ホストとは、API Connect Collective 内のサーバーを実行するためにセットアップされたマシンであり、SSH デーモンがインストールされ、API Connect Collective に登録されています。

Collective メンバーは、Collective コントローラー によって管理されます。このコントローラーは、API Connect Collective の状態を保守する (WebSphere Application Server) Liberty Network Deployment Java サーバーです。Collective コントローラーは、コントローラー・ホスト・マシン上で稼働します。Collective コントローラーは API Connect Collective の中央制御ポイントとしての役割を果たし、ファイル転送、クラスター管理などの操作を実行します。また、ストレージおよびコラボレーション機能も備えています。 具体的には、Collective コントローラーは公開された LoopBack アプリケーションをサーバーとして メンバー・ホストにデプロイし (SSH を使用)、サーバーを API Connect Collective に参加させ (Collective メンバーにするため)、アプリケーションを実行できるようにサーバーを始動する役割を果たします。

Collective コントローラーと Collective メンバーは、HTTPS を使用して双方向通信を行います。Collective メンバー間では、ネットワーク・ロケーション、セキュリティーの詳細、動作ステータスに関する情報が共有されるため、個々のメンバーに対して操作を実行することなく、これらの情報を容易に取得できます。また、Collective コントローラーは定期的にサーバーの正常性をモニターし、サーバーを再始動する必要があるかどうかを確認します。コントローラーはメンバー・アプリケーションに関する情報を (オンデマンド・ルーターを使用して) Micro Gateway および DataPower Gateway に公開し、ルーティング先として使用できるアプリケーションを把握できるようにします。さらに、API Connect Collective は、API Connect Collective をモニターするために使用できる Liberty Admin Center UI コンソールを Collective コレクターに提供します。この Admin Center には、API Manager UI から読み取り専用でアクセスできます。ソフトウェア・プロセスを実行する API Connect クライアントも、Collective コントローラーに接続して、API Connect Collective とそのメンバーシップに関する情報のクエリーを行ったり、操作を実行したりできます。

API Connect Collective は、スケーラビリティーと高可用性の要件に応じて、1 つ以上の Collective コントローラーで構成でき、複数のメンバー・ホストを使用できます。Collective コントローラーと Collective メンバーは、別々のホスト上にあっても、同じホスト上にあっても構いません。API Connect Collective について詳しくは、WebSphere Application Server Liberty Network Deployment の資料の「Liberty: Collective architecture」を参照してください。

以下の図に、Cloud Manager および API Manager が接続する API Connect Collective のアーキテクチャーを示します。Collective コントローラーは、3 つの Collective メンバーとは別のホスト上にあります。

API Connect Collective と他の API Connect コンポーネントの間での通信を有効にするには、API Connect Collective と Collective コントローラーが Cloud Manager 内で登録されている必要があります。

開発者ポータル

開発者ポータルは、アプリケーション開発者が API を探索およびディスカバーしてサブスクライブするために使用する、Web ベースのカスタマイズ可能なセルフサービス・ポータルを提供します。

API プロバイダーが API Manager で API を公開すると、それらの API は開発者ポータルに公開されて、開発者組織がディスカバーして使用できるようになります。アプリケーション開発者は 開発者ポータルの UI にアクセスして、開発したアプリケーションを登録し、必要な API をディスカバーして、(必要に応じてアクセス承認を取得した上で) それらの API をアプリケーションで使用してから、アプリケーションをデプロイできます。

開発者ポータルには、ソーシャル化およびコラボレーションに対応するために、フォーラム、ブログ、コメント、レーティングなどの追加機能が用意されています。API コンシューマーは、アプリケーションまたは開発者組織内で使用されている API に関する分析情報を表示することもできます。詳しくは、開発者ポータル: API のディスカバーおよび使用を参照してください。

API Connect サーバー要件

オンプレミス・クラウドから、API を作成、プロモート、使用、および追跡できます。オンプレミス・クラウドはさまざまなアプライアンスで構成されており、それぞれのアプライアンスは特定タイプのサーバーです。サーバーの集合により、ご使用のクラウドが定義され、データの管理、分析、ルーティング、および保管の作業をどのように分散させるかが決まります。

オンプレミス・クラウドは、新規と既存の物理アプライアンスと仮想アプライアンスを組み合わせて構成することも、仮想アプライアンスのみで構成することもできます。 API Connect 環境のサーバーのタイプと数は、各企業の個別のニーズによって決まりますが、最小要件として、管理サーバー、ゲートウェイ・サーバー、および開発者ポータルをホストするサーバーがそれぞれ 1 つ必要です。

クラウドのプランについて詳しくは、クラウドのプランを参照してください。

インターフェース・コンポーネントごとの通常のタスク

API Connect では、コマンド・ライン・インターフェースとグラフィカル・ユーザー・インターフェースの両方を提供しています。通常のタスクを行うために使用するインターフェースは、プロバイダー組織と開発者組織で異なります。以下の表を参照して、特定のタスクに対応するインターフェースを確認してください。