この章では、Oracle API Catalog (OAC)の概要を示し、OACの使用に関する基本概念について説明します。
この章は次の項で構成されています。
開発の際に、企業のシステム・オブ・レコード(SoR)に加えて、アプリケーション・プログラミング・インタフェース(API)を使用するモバイル・アプリケーションが増えています。使用可能なAPIの数は日に日に増加しています。これらの使用が、モバイル・デバイスおよびコンピューティング・プラットフォーム(Web、タブレット、スマートフォン、テレビ、ビデオ・ゲーム機、自動車、およびその他の家庭用機器(モノのインターネット、Internet of Things))の数の増加につれて拡大しています。組織によって作成および使用されるAPIの数が増加しているため、これらのAPIの管理と可視化の重要性が高まっています。
Oracle API Catalog (OAC)を使用すると、組織がAPIのカタログを容易に作成して、アプリケーション開発のためにAPIを可視化できます。OACには、APIアセットの単純なメタモデルやOACへのデータ入力の自動化機能が含まれます。また、ユーザーがOACでAPIを検索し、APIの詳細を把握して自分のアプリケーションにAPIが適しているかどうかを評価することもできます。
この項では、Oracle API Catalogに含まれる機能の概要を説明します。この項には次のトピックが含まれます:
OACに含まれるハーベスタを使用して、OACにAPIアセットを作成します。推奨されるベスト・プラクティスは、構築時にプロジェクトを収集することです。ハーベスタが、デプロイ済のサービスを調査して、プロジェクトで検出されたSOAサービスおよびService Busプロキシ(WSDLベースWebサービスとWADLベースRESTサービスの両方)を表すAPIアセットを作成します。
作成されたアセットがOracle API Catalogに収集されます。
OACでのサービス収集方法の詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』の自動収集の構成と使用に関する項を参照してください。
APIアセットがハーベスタによって作成されると、キュレータが単純なエディタを使用してAPIアセットを編集し、APIの検出と理解に役立つメタデータを追加します。キュレータは、Oracle API Catalogに収集されたAPIアセットについて、名前の変更、説明の追加、キーワードのタグ付け、およびドキュメント参照の追加を行うことができます。このメタデータによって、開発者による各APIアセットの検出と理解が容易になります。
詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』のOracle API CatalogでのAPIアセットのメタデータの編集に関する項を参照してください。
APIメタデータを編集したら、キュレータはAPIを公開して、OACで開発者が表示できるようにします。
詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』のAPIアセットの公開に関する項を参照してください。
公開されたアセットは、Oracle API CatalogコンソールやOracle JDeveloper Oracle Enterprise Repositoryプラグインで使用できるようになります。開発者はOACを検索して、使用するAPIを検出できます。キュレータが提供したメタデータを表示して、APIの詳細を確認できます。
開発者は、使用できそうなAPIを見つけたら、そのAPIを自分のMy APIページに追加できます。My APIで、開発者はAPIの評価とレビューを行うことができます。これらの評価とレビューは他のOACユーザーが表示できます。
APIアセットの検出、理解および使用の詳細は、『Oracle Fusion Middleware Oracle API Catalog開発者ガイド』を参照してください。
各OACユーザーにはロールが割り当てられます。このロールによって、各ユーザーが使用できるOACの機能とコンテンツが決定されます。OACには3つのロールが事前定義されています。
注意: Oracle API Catalogには追加のロールを作成する機能はありません。 |
開発者: 開発者ロールのユーザーは、OACコンソールまたはOracle Enterprise Repository JDeveloperプラグインを使用して、OAC内の公開済APIを検索できます。開発者はAPIをよく理解するためにAPIメタデータを調べることができます。また、開発者はAPIに対する関心を宣言したり、APIの評価とレビューを送ったりすることができます。
開発者としてOracle API Catalogを使用する方法の詳細は、『Oracle Fusion Middleware Oracle API Catalog開発者ガイド』を参照してください。
キュレータ: APIアセットが作成されたら、キュレータはそれらを編集してメタデータを更新します。また、キュレータは、開発者が検出できるようにAPIを公開することもできます。
キュレータ・ロールを持つユーザーが実行できるライフサイクル・タスクの詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』のアセットのライフサイクル管理タスクに関する項を参照してください。
管理者: 管理者ロールのユーザーはキュレータ・ロールと開発者ロールの機能に加え、アセットをOACに収集できます。また、このロールを持つユーザーはOACの管理者ページにアクセスできます。このページでは、このロールを持つユーザーが、システム設定の編集、新規ユーザーの作成、新規部署の作成、セッションの管理およびインポート/エクスポート・ツールの使用によって、OACのインフラストラクチャを管理できます。このロールを持つユーザーは、OACに含まれるセキュリティ機能も構成できます。
管理者ロールを持つユーザーが実行できるインフラストラクチャ管理タスクの詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』のインフラストラクチャ管理タスクに関する項を参照してください。
管理者ロールを持つユーザーが実行できるセキュリティ構成タスクの詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』のセキュリティ管理タスクに関する項を参照してください。
第2章「Oracle API Catalogのスタート・ガイド」を参照して、Oracle API Catalogの使用を開始します。