| Oracle® Fusion Middleware Oracle API Catalog開発者ガイド 12cリリース1 (12.1.3) E59449-03 |
|
 前 |
 次 |
この章では、Oracle API Catalogコンソールを使用する方法について説明します。
この章の内容は次のとおりです。
この項では、次の処理について説明します。
Oracle API Catalogにログインするには、次の手順を実行します。
ブラウザを使用して、Oracle API Catalogを開きます。
ログイン画面で、「ユーザー名」ボックスと「パスワード」ボックスに適切な情報を入力します。
「サインイン」をクリックします。
ログインすると、図2-1に示すように、Oracle API Catalogのホーム・ページが表示されます。画像のAPIはただの説明目的のものであることに注意してください。OACには例のAPIは含まれません。
Oracle API Catalogメニュー・バー
Oracle API Catalogのメニュー・バーは、コンソール上部で動作します。このメニュー・バーを使用すると、Oracle API Catalog内で様々なツールと機能にナビゲートできます。
メニュー・バーに表示される要素は、現在サインインしているユーザーのロールによって決まります。たとえば、開発者ロールを持つユーザーがサインインしている場合、検索リージョンの公開ステータス・オプションを持つリストや「管理」ボタンは表示されません。Oracle API Catalogにおけるユーザー・ロールの詳細は、第2.2項「ユーザー・ロールの説明」を参照してください。
検索
検索リージョンは、APIカタログのAPIを検出するための主な手段です。
選択した基準を使用してアセットを検出するには、検索リージョンを使用します。検索の詳細は、第2.3.1.1項「標準検索の実行」を参照してください。
API Catalogホーム
APIカタログ・ホーム・ボタンをクリックすると、API Catalogホーム・ページに移動します。API Catalogホーム・ページには、最近公開されたAPIや最近レビューされたAPIのほか、API検索が表示されます。
マイAPI
マイAPIボタンをクリックするとマイAPIページに移動します。マイAPIページには、関心があると宣言したAPIがすべて収集され、APIの詳細とレビュー送信ページにすばやくアクセスできます。
検索の詳細は、第2.3.3項「マイAPIの管理」を参照してください。
管理
「管理」ボタンをクリックすると「管理」ページに移動します。適切なロールを持つユーザーは、「管理」ページから、API Catalogのインフラストラクチャを構成できます。これらのタスクの詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』を参照してください。
|
注意: 「管理」ページは、「管理」ロールを持つユーザーのみ利用できます。 |
ユーザー・メニュー
名前をクリックすると、ユーザー・メニューが展開します。このメニューからは、ヘルプのアクセス、パスワードの変更またはOracle API Catalogからサインアウトが可能です。
Oracle API Catalogからログアウトする手順:
Oracle API Catalogメニュー・バーから、ユーザー名の右にあるメニュー・アイコンをクリックすると、ユーザー・メニューが展開します。
「サインアウト」を選択します。
Oracle API Catalogのユーザーは、ロールによって定義されます。各ロールには、ユーザーが具体的なタスクを実行できる特定の権限があります。
次に、Oracle API Catalogに付属のデフォルト・ロールについて説明します。
developer: developerロールを持つユーザーは、OACコンソールから、またはOracle Enterprise Repository JDeveloperプラグインを使用して、OAC内で登録済APIを検索できます。developerは、APIメタデータを調査してAPIの理解度を高めることができます。developerは、APIに対する関心を宣言して、APIの評価とレビューを送信することができます。
このガイドは、developerロールを持つユーザーが実行するタスクについて説明しています。
curator: curatorロールを持つユーザーは、developerロールが利用できる機能に加えて、ハーベスタを実行してOACに新しいAPIアセットを作成できます。curatorは、作成されたAPIアセットを編集してメタデータを更新します。curatorはAPIを公開する能力も持っており、そうすると、developerがAPIを検出できるようになります。
curatorロールを持つユーザーが実行できるライフサイクル・タスクの詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』のアセット・ライフサイクル管理タスクの導入に関する項を参照してください。
admin: adminロールを持つユーザーは、curatorとdeveloperロールが利用できる機能に加えて、OACの「管理」ページにアクセスできます。このロールを持つユーザーは、このページから、システム設定の編集、新しいユーザーの作成、新しい部門の作成、セッションの管理、およびインポート/エクスポート・ツールの使用によって、OACのインフラストラクチャを管理できます。このロールを持つユーザーは、OACとともに含まれるセキュリティ機能を構成することもできます。
adminロールを持つユーザーが実行できるインフラストラクチャ管理タスクの詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』のインフラストラクチャ管理タスクの導入に関する項を参照してください。
adminロールを持つユーザーが実行できるセキュリティ構成タスクの詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』のセキュリティ管理タスクの導入に関する項を参照してください。
この項では、Oracle API Catalogでアセットを操作する方法について説明します。このセクションでは、次のトピックについて説明します。
|
注意: Oracle API Catalogが利用できる唯一のアセット・タイプは、APIアセット・タイプです。 |
様々な方法を使用して、アセットをOracle API Catalogで検索できます。この項では、Oracle API Catalogでアセットを検索する方法の一部を示します。
|
注意: Oracle API Catalogが利用できる唯一のアセット・タイプは、APIアセット・タイプです。 |
検索は、Oracle API Catalogメニュー・バーの検索リージョンから実行します。
「検索」フィールドにキーワードを入力します。
(オプション)リストからサービスのタイプ(「すべてのサービス」、「REST」または「SOAP」)を選択します。
(オプション)リストから公開ステータスを選択します(「公開」、「ドラフト」またはすべてのAPI)。
|
注意: 検索リージョンでリストに公開ステータス・オプションを表示するためには、curatorまたはadminロールを持っている必要があります。 |
「検索」ボタンをクリックします。「検索結果」ページに結果が表示されます。
「名前」、「説明」など、特定のフィールドを検索できます。
|
注意: 特定のフィールドを検索するには、cmee.search.specific.fieldシステム設定を有効にしておく必要があります。システム設定の詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』のシステム設定の概要の項を参照してください。 |
次の構文を使用して、nameフィールドのみでmyAssetに関する検索を実行します。
name:myAsset
次の構文を使用して、descriptionフィールドのみでmyAssetに関する検索を実行します。
description:myAssetまたはdesc:myAsset
図2-2 に示すように、検索結果が「検索結果」タブに表示されます。
「検索結果」タブから、結果の詳細をzip、PDFまたはMicrosoft Excelファイルにエクスポートできます。詳細は、第2.3.6項「アセット詳細のエクスポート」を参照してください。
adminロールを持つユーザーは、検索結果ページからOACのアセットを削除することもできます。詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』の、Oracle API CatalogでのAPIアセットのメタデータの編集に関する章を参照してください。
API Catalogホーム・ページには、最近公開またはレビューされたアセットが、目立つように表示されます。このため、関心の対象となる、直近に変更されたAPIにすばやくアクセスできます。
最近公開されたAPIを検索する手順:
API Catalogホーム・ボタンをクリックすると、API Catalogホーム・ページに移動します。
最近公開されたAPIセクションに表示されたAPIをレビューします。curatorが直近に公開したAPIはここに表示されます。
最近レビューされたAPIを検索する手順:
API Catalogホーム・ボタンをクリックすると、API Catalogホーム・ページに移動します。
最新レビュー・セクションに表示されたAPIをレビューします。直近にレビューされたAPIはここに表示されます。
API詳細は、表形式またはフレーム形式で表示できます。API詳細ページには、APIの使用、機能および履歴に関する様々な情報が示されます。通常、アセット・メタデータは、Oracle Enterprise Repositoryを介するプレゼンテーションの前に、curatorにより提供およびレビューされます。
検索の実行後、検索結果にリストされたアセットをクリックすると、そのAPI詳細が開きます。
Webコンソールでのアセット検索に関する検索結果は、初期検索パフォーマンスを改善するため、デフォルトで制限されるようになりました。結果の数は、「管理」|「システム・プロパティ」画面のcmee.search.assets.maxresultsで設定可能です。最大値を超える数の結果が検索された場合、検索結果の画面に、すべての結果を戻すリンク「すべて表示」とともに、結果の数が「結果(1000/2345)」のように表示されます。
|
注意: Oracle API Catalogが利用できる唯一のアセット・タイプは、APIアセット・タイプです。 |
マイAPIには、関心があるAPIが収集されます。マイAPIリストに追加したすべてのAPIが、マイAPIページに表示されます。各ユーザーに独自のマイAPIページがあるため、別のユーザーが関心を示しているが自分は関心がないAPIは表示されません。APIがマイAPIに追加されると、他のユーザーに対して表示されるレビューや評価を追加できます。
この節では、次のタスクについて説明します。
使用中または使用することに関心があるAPIは、マイAPIリストに追加することをお薦めします。
|
注意: 使用するAPIは常にマイAPIに追加することをお薦めします。Oracle API Catalogでは、このようにして使用状況メトリックが決定されます。 |
マイAPIにAPIを追加する手順:
検索を実行して関心があるAPIを検索します。第2.3.1.1項「標準検索の実行」を参照してください。
「検索結果」ページでAPIをクリックして、そのAPIの詳細ページを開きます。
APIのメタデータをレビューしてから、マイAPIへの追加アイコンをクリックします。第2.3.3.1項「マイAPIへの追加アイコン」を参照してください。これで、このAPIがマイAPIページに表示されます。
|
注意: APIがマイAPIにすでに追加されている場合、マイAPIへの追加アイコンでなくレビューの発行アイコンが表示されます。 |
マイAPIからAPIを削除する手順:
マイAPIボタンをクリックして、追加されているAPIをすべて表示します。
図2-4に示すように、削除する各APIに対して「削除」アイコンをクリックします。
API履歴を表示すると、APIの使用状況を考察することができます。Oracle API Catalogでは、APIを何人のユーザーがマイAPIページに追加したかを追跡しています。
APIの履歴を表示する手順:
マイAPIボタンをクリックしてMy APIsを開きます。
マイAPIページで、レビューするAPIを検索します。タイトルをクリックして、そのAPIの詳細ページを開きます。
APIの詳細ページで、使用履歴の表示をクリックします。図2-5を参照してください。
「使用状況」ダイアログが開きます。「使用済」グラフには、所定の期間にこのAPIをMy APIページに追加したユーザー数が表示されます。ダイアログの下部の表には、現在このAPIをMy APIsに追加しているユーザーが表示されます。
APIの詳細ページには、APIをアプリケーションに組み込む際に役立つ情報が表示されます。OACコンソールを使用して、APIと対話するために使用できるエンドポイントURLを検出できます。また、IDEにインポートできるWSDLまたはWADLファイルのURLを検索することもできます。
IDEに使用できるAPI用のエンドポイントを検出する手順:
マイAPIリストで、エンドポイントURLを表示するAPIを検索します。その詳細ページを開きます。
エンドポイントのURLは、技術情報リージョンに表示されます。
それをコピーしてコードまたはIDEに貼り付けることによって、このURLを介してAPIと対話できます。
APIに関連付けられたWSDLまたはWADLファイルを表示する手順:
マイAPIリストで、WSDLまたはWADLファイルを表示するAPIを検索します。その詳細ページを開きます。
URLが表示されるリージョンは、SOAPサービスとRESTサービスのどちらを表示しているかにより異なります。
SOAPサービスの場合、ファイル場所URLがWSDLサマリー・リージョンに表示されます。
RESTサービスの場合、WADL URLが技術情報リージョンに表示されます。
ファイルの内容を表示するには、URLをクリックします。URLを右クリックしてファイルを保存し、それをIDEでアプリケーションにインポートすることもできます。
アセットを使用した個人は、アセットの論評や評価を提供できます。これらのレビューは、他のユーザーや、アセットを管理するユーザーに役立ちます。ユーザーがコミュニティで他のユーザーと経験を共有する機会が得られます。
|
注意: Oracle API Catalogが利用できる唯一のアセット・タイプは、APIアセット・タイプです。 |
次の手順に従い、アセットの評価とレビューの発行を行います。
|
注意: マイAPIに追加されたアセットのみ、レビューできます。 |
APIの詳細は、次のいずれかの形式でエクスポートできます。
APIの情報をExcelのスプレッドシートにエクスポートできます。これは、APIの情報を別のツールにインポートするのに役に立つ場合があります。
次の方法を使用して、詳細をExcelファイルにエクスポートできます。
|
注意: ハイパーリンク(たとえば、「エンドポイントURI」フィールドまたはWADL URLフィールド)を含むフィールドに、128以上の文字が含まれている場合、エクスポートは失敗します。 |
この手順は、Oracle API Catalogのホーム・ページで実行されます。
検索は、「検索」フィールドにキーワードを入力することによって実行します。必要に応じて、リストからサービス・タイプと公開ステータスを選択して検索を絞り込みます。
検索結果から1つ以上のAPIを選択するには、「検索結果」ページにリストされたAPIの左側に表示されるチェック・ボックスにチェックを入れます。
ペイン上部のリストで「Excelにエクスポート」を選択します。
|
注意: 「Excelにエクスポート」オプションは、cmee.asset.registry.export.excelプロパティが有効な場合のみ表示されます。これはデフォルトで有効ですが、移動する場合、このプロパティが有効になっていない場合の問題に直面することがあります。 |
「実行」をクリックします。エクスポートの進捗状況は、次のオプションを含む進捗状況ウィンドウに示されます。
ジョブの終了をクリックすると、エクスポートが終了します。
監査ログを表示をクリックすると、エクスポート・プロセスのログが開きます。
エクスポートが完了したら、進捗ウィンドウでExcelスプレッドシートを表示をクリックします。スプレッドシートがMicrosoft Excelで開きます。
APIが横向きにリストされ、API詳細の要素が淡緑色の背景に示されます。
この手順は、Oracle API Catalogのホーム・ページで実行されます。
適切なAPIを見つけます。
詳細ページで「Excel」アイコンをクリックします。エクスポートの進捗状況は、進捗状況ウィンドウに示されます。
エクスポートが完了したら、進捗ウィンドウでExcelスプレッドシートを表示をクリックしてMicrosoft Excelにスプレッドシートを開きます。
この手順は、Oracle API Catalogのホーム・ページで実行されます。
詳細ページからPDFにアセット詳細をエクスポートできます。
検索または他の方法で適切なAPIを見つけます。
APIの詳細で「PDF」アイコンをクリックします。
この操作が求められる場合、リストから印刷テンプレートを選択します。
Adobe Acrobatプラグインがインストールされている場合、ブラウザでPDFが開きます。それ以外は、ファイルを保存するか開くように求められます。
検索は、検索フィールドに検索語を入力することによって実行します。
(オプション) 必要に応じて、リストからサービス・タイプまたは公開ステータスを選択して検索を絞り込みます。
|
注意: 検索リージョンでリストに公開ステータス・オプションを表示するためには、curatorまたはadminロールを持っている必要があります。 |
検索結果から1つ以上のAPIを選択するには、「検索結果」にリストされたAPIの左側に表示されるチェック・ボックスにチェックを入れます。
APIリストの上にあるリストでPDFにエクスポートを選択します。
「実行」をクリックします。
Adobe Acrobatプラグインがインストールされている場合、ブラウザでPDFが開きます。それ以外は、ファイルを保存するか開くように求められます。
ZIPにエクスポート機能が有効な場合、この機能を使用すると、アセット検索結果画面のメニュー選択によって、アセット情報をZIPファイルにエクスポートできます。
ZIPにエクスポート機能は、管理者権限を持つユーザーのみが利用できます。
「インポート/エクスポート」を有効にする必要があります。詳細は、『Oracle Fusion Middleware Oracle API Catalog管理者ガイド』の、システム設定の概要の章を参照してください。
この手順は、Oracle API Catalogのホーム・ページで実行されます。
アセット検索は、「検索」フィールドにキーワードを入力することによって実行します。必要に応じて、サービス・タイプまたは公開ステータスを選択して検索を絞り込みます。
|
注意: 検索リージョンでリストに公開ステータス・オプションを表示するためには、curatorまたはadminロールを持っている必要があります。 |
検索結果リストのチェック・ボックスを使用して、ZIPにエクスポートするAPIを選択します。
リストからZIPにエクスポートを選択します。
「実行」をクリックします。ZIPにエクスポート進捗ダイアログが表示されます。
エクスポートが完了したら、「ダウンロード」をクリックして、エクスポートしたZipファイルをダウンロードします。ファイルのダウンロード・ダイアログが表示されます。
「開く」、「保存」または「取消」を適宜選択します。
