| Oracle® Fusion Middleware Oracle API Managerの使用 12c (12.2.1.1.0) E79333-01 |
|
 前へ |
 次へ |
APIを作成した後、トラフィックを受信する前に、メタデータをAPIに追加してAPIを公開する必要があります。この章では、API ManagerとともにインストールされるOracle Service Busコンソールを使用したWSDLベースのSOAPプロキシ・サービスとRESTプロキシ・サービスのAPIとしてのキュレートおよび公開について説明します。
ここで説明されているタスクは、API Curatorロールを持つユーザーが実行します。
注意:
この章のタスクを開始する前に、APIプロキシ・サービスを作成してアクティブ化する必要があります。詳細は、「APIの作成」を参照してください。
内容は次のとおりです。
プロキシ・サービスを作成したら、API Manager PortalでAPI詳細ページに表示される説明的なメタデータを追加できます。
APIコンシューマは、このメタデータを使用してAPIが自分のアプリケーションに対して適切な選択肢かどうかを判断し、APIをテストします。Service Busコンソールへのアクセス権を持つユーザーもメタデータを使用してそのAPIを評価できます。
APIのメタデータを編集するには:
APIのステータスにより、API Manager Portalに対して非公開になるか、公開されるかが決まります。
次の図に示すように、APIステータスは、「API」タブの「パブリッシュ・ステータス」リージョンの「ステータス」リストで設定します。
APIには次のステータスを設定できます。
ドラフト: ドラフトAPIは、Oracle API Manager Portalに公開されず、それに対するリクエストはすべてブロックされます。このオプションがデフォルトです。
プライベート: プライベートAPIは、Oracle Service BusでDeveloper権限を持つユーザーが使用できます。プライベートAPIは、API Manager Portalに表示されず、API Consumerロールを持つユーザーは使用できません。APIのプライベート化の説明は、「APIのプライベート化」を参照してください。
公開済: 公開済APIは、Oracle API Manager Portalでコンシューマに公開されます。APIの公開の説明は、「Oracle API Manager PortalへのAPIの公開」を参照してください。
Service BusでDeveloper権限を持つユーザーが使用できるようにする場合は、APIをプライベートにできます。「「プライベート」」とマークされたAPIは、API Manager Portalに表示されず、API Consumerロールを持つユーザーは使用できません。
APIをプライベートにするには:
API Manager PortalからコンシューマがAPIを使用できるようにするには、管理対象とするか管理対象外とするかを決める必要があります。次に、ステータスを「公開済」に変更してAPIを公開します。
ヒント:
必ず「APIのメタデータの編集」の説明に従ってAPIにメタデータを追加してから、API Manager Portalに公開します。
APIを公開する前に、APIを管理対象として公開するか、管理対象外として公開するかを決定する必要があります。
管理対象APIは、実行時にアプリケーションの権限キーをヘッダーとして渡すことによってのみ起動できます。ユーザーは、APIにサブスクライブしてこのキーを受信する必要があります。ユーザーがキーを使用しないで管理対象APIを起動しようとすると、エラー・メッセージが表示されます。
管理対象外APIは、実行時に制御されず、権限キーを渡さずにアクセスできます。ユーザーは、サブスクライブせずにこのようなAPIを起動できます。
「「公開済」へのAPIステータスの変更」で説明されているように、APIを公開して管理対象にする際に「管理対象」チェック・ボックスを選択します。後でAPIを非公開にすることにした場合は、「管理対象」チェック・ボックスの選択を解除します。
注意:
すでに管理対象のAPIを管理対象外にすることにした場合、アプリケーションの権限キー(管理対象APIには必要、管理対象外APIには不要)が含まれるAPIに対するユーザー・リクエストでは、ヘッダーのX-API-KEY属性が無視されます。リクエストは通常どおりに処理されます。
APIを公開した後で、API Manager Portalで表示されないようにし、そのAPIに対するリクエストをすべてブロックすることにした場合は、ステータスを「ドラフト」に戻すことができます。
注意:
Service Busコンソールからプロキシ・サービスを削除すると、API Manager Portalからも削除されます。
APIのステータスを「ドラフト」に変更するには:
非推奨APIは、API Manager Portalに公開されたままになります。ユーザーは、非推奨APIの詳細を表示できますが、サブスクライブはできません。
どのAPIが非推奨バージョンよりも優先されるかなど、APIが非推奨になった理由について詳細を指定できます。
注意:
非推奨になる前にAPIにサブスクライブしていたユーザーは、引き続きサブスクライブしています。APIに対するリクエストは通常どおりに処理されます。
APIを非推奨にするには:
