| Oracle® Fusion Middleware Oracle API Catalog管理者ガイド 12cリリース1 (12.1.3) E59448-03 |
|
 前 |
 次 |
この章では、Oracle API Catalogで収集したAPIアセットのメタデータの編集、およびAPIアセットの公開について説明し、開発者のロールを持つユーザーがAPIを発見し、使用できるようにします。
APIアセットが収集されると、第5章「自動収集の構成と使用」の説明のとおり、キュレータまたは管理者のロールを持つOracle API Catalogユーザーは、そのメタデータを編集でき、開発者によるAPIの発見と理解を容易にできます。たとえば、キュレータがキーワードを追加して、特定のキーワードによる検索の際にアセットをより検出しやすくできます。キュレータはまた、収集され、Oracle API Catalogに追加された各APIの詳細な説明およびドキュメントへのリンクを追加できます。
この章で説明しているロールの詳細は、『Oracle Fusion Middleware Oracle API Catalogコンセプト・ガイド』のロール・ベースの機能に関する項を参照してください。
この章には、次のセクションがあります。
キュレータのロールを持つユーザーは、APIアセットを収集した後、メタデータを追加する必要があります。
APIアセットのメタデータを編集する手順は、次のとおりです。
メタデータを編集するAPIアセットを検索します。API検索の詳細は、『Oracle Fusion Middleware Oracle API Catalog開発者ガイド』のアセットの検索に関する項を参照してください。
「検索結果」ページのAPIをクリックし、その詳細ページを開きます。
図6-1に示すように、「編集」アイコンをクリックします。APIのアセットの編集ページが表示されます。
|
注意: APIアセットの詳細ページのすべての情報を編集できるわけではありません。たとえば、APIの技術的情報、WSDLサマリーおよびハーベスタ・プロパティは編集できません。 |
APIに関連する任意の新規メタデータを追加します(または、既存のメタデータを編集します)。
編集できるメタデータを次に示します。
名前: Oracle API Catalogに表示されるAPIアセットの名前。このフィールドは、ハーベスタにより自動的に移入されます。デフォルトの名前のままにしておく必要はありません。このAPIのための、わかりやすいものに変更できます。このフィールドは必須です。
バージョン: APIアセットのバージョン。ハーベスタにより、コンポジットで検索した情報に基づいてデフォルトのバージョンが埋められます。コンポジットでバージョン情報が見つからない場合は、ハーベスタがデフォルトのバージョンを割り当てます。このAPIのための、わかりやすいものに変更できます。
キーワード: ユーザーが検索結果でこのアセットを検索するために使用できるキーワード。platform=linuxなどの名前と値のペアを含めることもできます。各キーワードはカンマで区切ります。
|
注意: 「キーワード」フィールドに入力できる最大文字数は4000です。 |
APIステータス: APIの公開ステータス。APIが初めて収集されたときに、デフォルトで「ドラフト」に設定されます。アセットを公開する場合は、開発者が検出できるように、リストから「公開」を選択します。APIアセットの公開の詳細は、6.2項「APIアセットの公開」を参照してください。
アクティブ・ステータス: APIのアクティブ・ステータス。デフォルトで「アクティブ」が選択されます。APIをリタイアする場合は、「リタイア」を選択します。
|
注意: APIをリタイアした場合、その公開ステータスに関係なく、開発者には検出されません。 |
説明: APIの機能の詳細な説明で、機能およびAPIの使用方法についての関連情報を含みます(セキュア・エンドポイントURLなど)。
説明フィールドにはHTMLタグを使用でき、リンクや連絡先などの新規要素を追加できます。たとえば、説明フィールドに<b>Contacts:</b>John Smith<br>を追加することで、John Smithという名前を含む、検索可能なContacts要素を追加できます。
このフィールドでHTMLタグを機能させるには、cmee.asseteditor.enable-embedded-html-asset-descriptionシステム設定を有効にする必要があります。
|
注意: 「説明」フィールドに入力できる最大文字数は4000です。 |
ドキュメントURL: そのAPIについてのドキュメントのURL。単一のドキュメント、wikiページまたは複数のドキュメントへのリンクを集めた別のページにリンクできます。このURLは、APIアセットの詳細ページへのクリック可能なリンクになります。
アイコン: 次のいずれかを選択します。
アイコンURL: そのAPIに使用するアイコンを指すURL。アイコンのプレビューを表示するには、プレビューをクリックします。
アイコンのアップロード: 「参照」をクリックし、APIに使用するローカル・マシン上のアイコンを参照します。
「保存」をクリックして変更を保存します。
収集されたAPIアセットは、開発者には検出できません。キュレータまたは管理者のロールを持つユーザーは、開発者にそれが見えるようにAPIを公開する必要があります。
APIを公開する手順は、次のとおりです。
公開するAPIアセットを検索します。API検索の詳細は、『Oracle Fusion Middleware Oracle API Catalog開発者ガイド』のアセットの検索に関する項を参照してください。
|
ヒント: リストから「ドラフト」を選択すると、未公開のAPIのみが表示されます。 |
「検索結果」ページのAPIをクリックし、その詳細ページを開きます。
「編集」アイコンをクリックします。APIのアセットの編集ページが表示されます。
APIステータスのリストから「公開」を選択します。
「保存」をクリックして変更を保存します。これで、開発者のロールを持つユーザーは、検索でこのアセットを検出できます。このAPIは、Oracle API Catalogのホームページの最近公開されたAPIセクションに表示されます。
API詳細ページにドキュメントまたは別のAPI詳細ページのリンクを追加する場合、EasyLinkが役立つ可能性があります。
図6-2に示すように、APIページにはEasyLinkアイコンが表示されます。このアイコンは、API詳細ページのURLを表示するポップアップ・ウィンドウを開くもので、クリップボードにコピーしたり、特定のAPIへのポインタとしてドキュメントや電子メール・メッセージに貼り付けたりできます。
API詳細ページにリンクを追加する手順は、次のとおりです。
リンクを作成するAPIの詳細ページに移動します。
EasyLinkアイコンをクリックします。
リンクを作成する場所にポップアップ・ウィンドウからURLを貼り付けます。
API詳細ページの「説明」フィールドへのリンクを追加する場合は、リンクにtarget="_blank"属性を追加し、新規タブで開くようにリンクを編集します。
Oracle API Catalogでアセットを削除するには、次の手順を実行します。
|
注意: 管理者のロールを持つユーザーのみがOracle API Catalogからアセットを削除できます。 |
Oracle API Catalogから削除するAPIアセットの検索を実行します。
APIを削除するには:
「検索結果」画面からAPIを削除するには、削除する各APIの横のチェック・ボックスを選択し、「削除」をクリックします。この方法を使用して、一度に複数のAPIを削除できます。
詳細ページからAPIを削除するには、削除するAPIの詳細ページを開き、「削除」をクリックします。
