機械翻訳について

Oracle API Platform Cloud Serviceを使用したAPIとしての統合の管理

API Platform Cloud Service統合を使用して、統合をAPIとして管理し、いくつかの統合を単一のAPIとしてグループ化することができます。

トピック:

Oracle API Platform Cloud Service統合の使用による新規APIの作成

API Platform Cloud Service統合との統合から、API Platform Cloud ServiceにAPIを作成できます。

始める前に:

  • OracleのAPI Platform Cloud Serviceインスタンスに接続します。 「Oracle API Platform Cloud Serviceに接続」を参照してください。

  • APIを作成する統合は、RESTエンドポイントをトリガーとして使用し、アクティブ化する必要があります。

APIとしての統合を管理するには:
  1. ナビゲーション・ペインで、「ホーム」>「統合」>「統合」をクリックします。
  2. API Platform Cloud Serviceで管理する統合の行に移動します。
  3. 「アクション」メニューメニューから、「APIプラットフォーム」を選択します。
  4. 「操作」リストから、「新しいAPIを作成」を選択します。
  5. 「API名」フィールドに、APIの名前を入力します。
  6. 「バージョン」フィールドに、APIのバージョンを入力します。
  7. 「APIエンドポイントURL」フィールドに、APIがAPI Platform Cloud Serviceゲートウェイにデプロイされたときにリクエストを受信するエンドポイントを入力します。 APIエンドポイントURLは、API Platform Cloud Serviceゲートウェイにデプロイされた各APIに対して一意でなければなりません。
  8. (オプション) 「APIの説明」フィールドに、統合の簡単な説明を入力します。 この説明は、API Platform Cloud Service管理および開発者ポータルに表示されます。
  9. (オプション) APIをゲートウェイにデプロイするには、「APIのデプロイ」を選択し、APIをデプロイするゲートウェイを選択します。 ユーザー(「Oracle API Platform Cloud Serviceに接続」)がデプロイメント権限を持っているゲートウェイのみが表示されます。 ユーザーがゲートウェイへのデプロイまたはゲートウェイへのデプロイメントのリクエストを付与していない場合、このオプションはグレー表示されます。
  10. (オプション) APIを開発者ポータルに公開するには、Publish APIを選択し、「APIポータルのURL」フィールドにバニティ名を入力します。 バニティ名は、API Platform Cloud Serviceによって管理される各APIに対して一意でなければなりません。 開発者ポータルに公開するために必要な権限がユーザーにない場合、このオプションはグレー表示されます。
  11. 「作成」をクリックします。
APIは、API Platform Cloud Service管理ポータルで作成されます。 また、これらのオプションを選択した場合は、デプロイまたは公開されます。
APIを作成したら、API Platform Cloud Service Management PortalでAPIを管理できます。

Oracle API Platform Cloud ServiceでのAPIでの統合のグループ化

API Platform Cloud Serviceでは、複数の統合をまとめて1つのAPIとして管理できます。

これにより、複数の関連する統合をAPI Platform Cloud Serviceの単一のAPIに簡単に組み合わせることができます。

グループ化する各統合は、API Platform Cloud ServiceのAPIに適用されるリソース・ベースのルーティング・ポリシーに条件を追加します。 統合に指定したリソースをリクエストするデプロイ済APIにリクエストが送信されると、このポリシーによって、リクエストが統合のエンドポイントにルーティングされます(リクエストがリソース・ベースのルーティング・ポリシーの前に実行フロー内のすべてのポリシーによって渡された場合)。

例: オーダーの管理用とペット・ストアの在庫管理用の2つの統合があります。 これらをアプリケーション開発者に公開したいのですが、誰がアプリケーションを使用し、どのリクエストを統合にルーティングするかを管理したいと考えています。 管理と検出を容易にするために、これらの統合をAPI Platform Cloud Serviceの単一のAPIにグループ化できます。 デプロイされると、APIはクライアントがリクエストするリソースに基づいて、各統合にリクエストをルーティングします。

始める前に:

APIで統合をグループ化するには:
  1. ナビゲーション・ペインで、「ホーム」>「統合」>「統合」をクリックします。
  2. API Platform Cloud Serviceで管理する統合の行に移動します。
  3. 「アクション」メニューメニューから、「APIプラットフォーム」を選択します。
  4. 「操作」リストから、「既存のAPIに追加」を選択します。
  5. 「API名」フィールドに、統合に追加するAPIの名前を入力します。

    ヒント:

    「検索: API名」アイコンをクリックして、統合を追加できるAPIを表示します。

  6. (オプション) APIをゲートウェイにデプロイするには、「APIのデプロイ」を選択し、APIをデプロイするゲートウェイを選択します。 ユーザー(「Oracle API Platform Cloud Serviceに接続」で指定)がデプロイメント権限を持つゲートウェイのみが表示されます。 ユーザーにゲートウェイへのデプロイ権限またはゲートウェイへのデプロイメントのリクエスト権限がない場合、このオプションは無効になります。
  7. (オプション) 開発者ポータルにAPIを公開するには、Publish APIを選択し、「APIポータルのURL」フィールドにバニティ名を入力します。 このオプションは、選択したAPIに対するAPIの管理権限がユーザーにない場合は無効になります。
  8. 「作成」をクリックします。
統合はAPIとグループ化されます。
APIとの統合をグループ化した後は、API Platform Cloud Service Management Portalで管理することができます。

APIからの統合のグループ解除

以前にグループ化されたAPIから統合をグループ化解除できます。

APIをグループ化解除すると、グループ解除された統合の条件が、APIに適用されたリソース・ベースのルーティング・ポリシーから削除されます。 APIがゲートウェイにデプロイされている場合は再デプロイされ、開発者ポータルに公開されている場合は再公開されます。

ノート:

このタスクでは、「Oracle API Platform Cloud ServiceでのAPIでの統合のグループ化」で説明されている、APIで他のユーザーとグループ化された統合を削除します。 統合がAPIに追加された唯一のエンドポイントである場合は、この操作を使用しないでください。 代わりにAPI Platform Cloud Service管理ポータルでAPIを削除してください。

APIから統合を解除するには:
  1. ナビゲーション・ペインで、「ホーム」>「統合」>「統合」をクリックします。
  2. APIからグループ解除する統合の行に移動します。
  3. 「アクション」メニューメニューから、「APIプラットフォーム」を選択します。
  4. 「操作」リストで「既存のAPIから削除」が選択されていることを確認し、「削除」をクリックします。

統合はAPIからグループ化解除されます。 統合のリソース・ベース・ルーティング・ポリシーの条件がAPIから削除されます。

ノート:

  • ターゲットAPIにグループ化された統合が1つしかない場合、グループ化解除は次のエラーで失敗します: 
    Remove from existing API failed due to the following reason: Operation failed: Unable to remove from a API which contains a single endpoint

  • APIがAPI Platform Cloud Serviceから削除されると、グループ化解除は成功します。 その後、この統合を通常どおりAPIから作成するか、APIにグループ化できます。

APIから統合を解除すると、API Platform Cloud Service Management PortalでAPIを管理できます。