この章では、Oracle API Managerを紹介し、その機能について説明します。また、使用を開始するための次のステップも示します。
内容は次のとおりです。
Oracle API Managerを使用すると、バックエンド・システムや他のサービスの機能を公開するAPIの作成が容易になります。このようなAPIは、アプリケーション開発者によって使用するために公開され、実行時に管理およびモニターされます。
アプリケーションでアプリケーション・プログラミング・インタフェース(API)を使用することが増えています。このようなAPIは、レコードのエンタープライズ・システムにアクセスするように内部または外部のエンティティによって開発できます。使用可能なAPIの数は日々増えています。その使用量には、増え続けるモバイル機器やコンピューティング・プラットフォーム(Web、タブレット、スマートフォン、TV、車およびその他の家庭用機器、すなわちモノのインターネット)の数がかけられます。組織が作成し使用するAPIの数が増加するのにつれて、このようなAPIの管理や認識度はますます重要になります。
API Managerは、開発者がAPIとして公開されるWSDLベースのSOAPプロキシ・サービスおよびRESTプロキシ・サービスを作成できるスタンドアロンのOracle Service Busインスタンスとともにインストールされます。
注意:
非推奨のWLS 9ポリシーで構成されたプロキシ・サービスは、APIとして公開できません。
Service Bus 12.2.1で作成したネイティブRESTサービス(型付き/型なしの両方)は、サポートされていません。12.1.3形式のWSDLベースのRESTサービスのみが、APIとして公開できます。『Oracle Service Busでのサービスの開発』のJDeveloperを使用したService Bus用WSDLベースのRESTサービスの作成方法に関する項を参照して、このタイプのRESTサービスをService Bus 12.2.1で作成してください。
APIキュレータは、このようなサービスのうちのどれを管理対象とし、開発者に公開するかを決定します。次に、APIキュレータはメタデータを追加し、アプリケーション開発者がサブスクライブしたり、APIの使用に必要な情報を表示するAPI Manager PortalにAPIを公開します。管理ユーザーはAPI Manager Portalを使用して、使用状況メトリックや実行時のパフォーマンス分析をモニターできます。
API Managerの使用例およびAPIの管理ライフサイクルの説明は、「Oracle API Managerの機能について」を参照してください。
API Managerでは、APIを作成して、ポータルに公開できます。また、目的のAPIを検索することもできます。さらに、アプリケーションを作成して、APIにサブスクライブすることもできます。
APIの作成: Service Busの機能を使用して様々なバックエンド・サービスのためのAPIとして公開するプロキシ・サービスを作成します。
プロキシ・サービスの開発の詳細は、『Oracle Service Busでのサービスの開発』のAPIの作成に関する項、およびプロキシ・サービスの作成と構成に関する項を参照してください。
説明的なメタデータの追加とポータルへのAPIの公開: API Curatorロールを持つユーザーが説明的なメタデータをAPIに追加し、APIを管理対象とするかどうかを決定してAPI Manager PortalにAPIを公開します。
APIキュレーション・タスクの詳細は、「Oracle Service Busを使用したAPIのキュレートおよび公開」を参照してください。
APIの検出と理解: API Consumerロールを持つユーザーがAPI Manager Portalを使用して興味があるAPIを検索し、そのメタデータを確認してAPIの機能を理解するためにテストします。
APIの検出とサブスクライブの詳細は、「APIの検出」を参照してください。
アプリケーションの作成とAPIへのサブスクライブ: API Managerで組織のアプリケーションを表すアプリケーションを作成する必要があります。アプリケーションが作成されると、API Consumerロールを持つユーザーがAPIをアプリケーションにサブスクライブできます。
アプリケーションの管理の詳細は「アプリケーションの管理」を、APIへのサブスクライブの詳細は「「サブスクリプション」ページからのAPIへのサブスクライブ」を参照してください。
実行時のAPIへのアクセス: ユーザーが興味があるAPIにサブスクライブすると、エンドポイントURLおよび権限キーを使用して、(APIとして公開された)バンクエンド・サービスにアクセスできます。
APIの使用方法の詳細は、「アプリケーションでのAPIの使用方法」を参照してください。
分析を使用したAPIパフォーマンスの理解: API Adminロールを持つユーザーがサブスクリプション・データおよび各種実行時分析をAPI Manager Portalでモニターします。
APIの使用状況の統計およびパフォーマンス分析の表示の詳細は、「「サブスクリプション」ページを使用したサブスクリプション統計の表示」および「Oracle API Managerでの分析の表示」を参照してください。
この項で説明されているユーザー・ロールの詳細は、「Oracle API Managerのユーザー・ロールについて」を参照してください。
API Managerでは特定のロールが使用できます。また、一部のService BusロールもAPI Managerで使用できます。
次のロールは、API Managerで使用するために作成されています。
API Curator: このロールを持つユーザーは、Service Busコンソールを使用して、プロキシ・サービスに関連付けられているメタデータをキュレートし、プロキシ・サービスをAPIとしてAPI Manager Portalに公開します。このロールを割り当てられたユーザーは、Service Busコンソールのリマインダへの読取り専用アクセス権を持つため、アーティファクト情報を表示できます。
API Consumer: このロールを持つユーザーは、API Manager Portalを使用してAPIを表示、サブスクライブ、使用できます。また、管理対象APIの実行時メトリックも表示できます。このロールを割り当てられたユーザーは、Service Busコンソールにアクセスできません。
API Admin: このロールを持つユーザーには、API Manager Portalの管理権限があります。API Adminユーザーは、ユーザーおよびAPIごとにAPI使用状況メトリック、分析情報、詳細なサブスクリプション情報を表示できます。このロールを割り当てられたユーザーは、Service Busコンソールにアクセスできません。
次のService BusロールもAPI Managerで使用されます。
Developer: このロールを持つユーザーは、Service Busコンソールを使用して、API Manager PortalでAPIとして公開できるプロキシ・サービスを作成します。
Administrator: このロールを持つユーザーには、Oracle WebLogic Serverへのフル・アクセス権に加えて、Service BusコンソールおよびAPI Manager Portalへのフル・アクセス権があります。このロールを割り当てられたユーザーは、API Manager Portalを使用してアセットにサブスクライブできません。
Deployer: このロールを割り当てられたユーザーは、Service Busアーティファクトとキュレーション情報の両方を含め、APIのデプロイを担当します。このロールは、既存のDeployer Service Busロールにマップされ、キュレーション・メタデータのインポート/エクスポートをさらに担当します。
Monitor: このロールを割り当てられたユーザーは、モニタリングを担当します。
既存のユーザー・ロールの詳細は、『Oracle Service Busの管理』の「Oracle Service Busのアクセス・セキュリティの定義」を参照してください。
API Managerでのユーザーの作成とそのユーザーへのロールの割当ての説明は、「Oracle API Managerでのユーザーの管理」を参照してください
API Managerをインストールして構成したら、Service BusでAPIをキュレートし、PortalでAPIを検出して使用します。また、その他の様々な管理タスクを実行します。
API Managerをインストールして構成するには、「Oracle API Managerのインストールと構成」の項目を参照してください。この部ではユーザーの作成についても説明します。
「Oracle API Managerのインストールと構成」で説明されているタスクを完了したら、Oracle Service Busを使用したAPIのキュレート、API Manager PortalによるAPIの検出および使用、API Managerの管理機能に関する各章について、「Oracle API Managerの使用」を参照してください。