17.4.7 RESTソース・カタログの管理

RESTデータ・ソースを作成するためにワークスペース内のすべてのアプリケーションで使用できるRESTデータ・ソース・メタデータのカタログを作成します。

RESTソース・カタログには、RESTデータ・ソースに関するメタデータが含まれます。開発者はカタログを検索して参照し、アプリケーションのRESTデータ・ソースを作成できます。RESTソース・カタログを共有するには、RESTデータ・ソース・カタログをファイルにエクスポートしてから、別のワークスペースまたは別のインスタンスにインポートします。

• RESTソース・カタログの作成
  ワークスペース・ユーティリティでRESTソース・カタログを作成します。
• OpenAPIからのRESTソース・カタログの作成
  OpenAPIファイルからRESTソース・カタログを作成します。
• RESTソース・カタログの編集
  「RESTソース・カタログ」ページで、既存のRESTソース・カタログを編集します。
• カタログ・グループの管理
  カタログ・グループを使用して、カタログをカテゴリに編成します。
• RESTソース・カタログのエクスポートおよびインポートについて
  RESTソース・カタログをファイルにエクスポートし、そのファイルをターゲット・インスタンスにインポートして、これを別のインスタンスに移動します。

17.4.7.1 RESTソース・カタログの作成

ワークスペース・ユーティリティでRESTソース・カタログを作成します。

RESTソース・カタログを作成するには:

1. RESTソース・カタログ・ページにナビゲートします。
   1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
   2. アプリケーション・ビルダーで、「ワークスペース・ユーティリティ」アイコンをクリックします。
   3. ワークスペース・ユーティリティ・ページで、「RESTソース・カタログ」をクリックします。
      RESTソース・カタログ・ページが表示されます。RESTソース・カタログは、グループと呼ばれるカテゴリに編成されます。最初にグループを作成し、次にカタログを作成します。
2. グループを作成します。
   1. 「タスク」リストから、「カタログ・グループの管理」を実行します。
   2. 「グループの作成」をクリックします。
   3. 「カタログ・グループ詳細」ダイアログで、次の項目を指定します。

      • 名前 - カタログ・グループの名前を指定します。

      • 説明 - グループの目的を説明します。

      • 「作成」をクリックします。

3. 「RESTソース・カタログ」ブレッドクラムをクリックして、RESTソース・カタログ・ページに戻ります。
4. カタログを作成します。
   1. 「カタログの作成」をクリックします。
   2. 「RESTソース・カタログ詳細」ダイアログで、次の項目を指定します。

      • グループ - カタログを編成し、サービスの作成時に開発者を支援するために使用するグループを選択します。

      • 名前 - カタログの名前を指定します。カタログ名はワークスペース内で一意である必要があります。

      • 内部名 - カタログの内部名を指定します。内部名は、複数のAPEXインスタンスでカタログを識別するために使用されます。カタログがインポートされ、同じ内部名のカタログがすでに存在する場合は、既存のカタログが上書きされます。

      • 説明 - RESTソース・カタログを説明します。

      • 「作成」をクリックします。

5. カタログに含めるRESTデータ・ソースを作成します。「RESTデータ・ソースの作成」を参照してください。
6. RESTデータ・ソースにRESTソース・カタログを割り当てます。
   1. RESTデータ・ソースを編集します。「RESTソース名」をクリックします。
   2. 「RESTソース・カタログ」で、「カタログに保存」をクリックします。
   3. 「RESTソース・カタログに保存」ダイアログで、次のことを確認します。

      • カタログ・グループ - カタログ・グループを選択します。サービスが既存のカタログに追加されない場合は、「新規カタログ・グループの追加」を選択し、画面の指示に従います。

      • カタログ - サービスを追加するカタログを選択します。サービスが既存のカタログに追加されない場合は、「新規カタログの追加」を選択します。

      • RESTソース名 - 現在のRESTソース名が表示されます。

   4. 「カタログに保存」をクリックします。
7. カタログに追加するRESTデータ・ソースごとに前述のステップを繰り返します。

17.4.7.2 OpenAPIからのRESTソース・カタログの作成

OpenAPIファイルからRESTソース・カタログを作成します。

単一のOpenAPIファイルに、REST APIの完全なカタログを含めることができます。Open APIファイルをアップロードすると、Oracle APEXは、それに含まれているAPI記述ごとにRESTソース・テンプレートを備えたRESTカタログを生成します。その後で、カタログからRESTソースを作成できます。

OpenAPIファイルからRESTソース・カタログを作成するには:

1. RESTソース・カタログ・ページにナビゲートします。
   1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
   2. アプリケーション・ビルダーで、「ワークスペース・ユーティリティ」アイコンをクリックします。
   3. ワークスペース・ユーティリティ・ページで、「RESTソース・カタログ」をクリックします。
      RESTソース・カタログ・ページが表示されます。RESTソース・カタログは、グループと呼ばれるカテゴリに編成されます。最初にグループを作成し、次にカタログを作成します。
2. 必要に応じて、グループを作成します:
   1. 「タスク」リストから、「カタログ・グループの管理」を実行します。
   2. 「グループの作成」をクリックします。
   3. 「カタログ・グループ詳細」ダイアログで、次の項目を指定します。

      • 名前 - カタログ・グループの名前を指定します。

      • 説明 - グループの目的を説明します。

      • 「作成」をクリックします。

3. 「RESTソース・カタログ」ブレッドクラムをクリックして、RESTソース・カタログ・ページに戻ります。
4. 「OpenAPIから作成」をクリックします。
5. 「OpenAPIのアップロード」で次のように操作します:
   1. ファイルのアップロード - OpenAPIドキュメントをアップロードします。オプションは次のとおりです。
      • ドラッグ・アンド・ドロップ - ページの中央にある「ファイルのアップロード」リージョンにファイルをドラッグ・アンド・ドロップします。
      • ファイルの選択 - 「ファイルの選択」をクリックし、ナビゲートしてファイルを選択します。
   2. OpenAPIエンドポイントURL - JSONファイルをアップロードするかわりに、OpenAPI情報が使用可能なURLを入力します。
   3. 「次」をクリックします。
6. 「OpenAPIからのカタログ」ダイアログに、次のフィールドが表示されます:
   1. グループ - カタログを編成し、サービスの作成時に開発者を支援するために使用するグループを選択します。
   2. カタログ - 既存のカタログを選択してそのカタログ内のすべてのサービスを更新するか、「新規カタログの作成」を選択します。
   3. 名前 - カタログの名前。カタログ名はワークスペース内で一意である必要があります。
   4. 内部名 - カタログの内部名。内部名は、複数のAPEXインスタンスでカタログを識別するために使用されます。カタログがインポートされ、同じ内部名のカタログがすでに存在する場合は、既存のカタログが上書きされます。
   5. 説明 - RESTソース・カタログを説明します。
   6. デフォルトRESTソース・タイプ - 「RESTデータ・ソース」タイプを指定します。
   7. デフォルト認証 - デフォルトの認証タイプを選択します。カタログからRESTデータ・ソースが作成される際に、このタイプの空の資格証明が作成されます。その時点で、資格証明名とシークレットを指定する必要があります。オプションは次のとおりです。
      • 認証なし
      • 基本認証
      • OAuth2クライアント資格証明フロー
      • Oracle Cloud Infrastructure (OCI)
      • 証明書/秘密キーのペア
      • HTTPヘッダー
      • URL問合せ文字列
   8. デフォルト・トークン・サーバーURL - 「デフォルト認証」が「OAuth2クライアント資格証明フロー」に設定されている場合にのみ表示されます。

      トークン・サーバーのURLを入力します。このトークン・サーバーは、OpenAPIファイル内のREST APIで使用され、これはOAuth2クライアント資格証明認証フローで保護されています。

   9. カタログ・リフレッシュURL - RESTソース・カタログをリフレッシュするには、カタログ・エクスポート・ファイルのダウンロード元のURLを指定します。
   10. 「カタログ・リフレッシュURL」に値がある場合は、さらに2つの属性が表示されます:
       • プロキシ・サーバー - RESTソース・カタログをリフレッシュする際に使用するプロキシ・サーバー。設定しないと、Oracle APEXインスタンス・プロキシが使用されます(定義されている場合)。
       • Web資格証明 - カタログをリフレッシュする際に使用するWeb資格証明を特定します。このWeb資格証明は、リフレッシュ・エンドポイントURLで認証が必要な場合に使用します。
   11. 「次」をクリックします。
7. 「RESTソース・タイプのデフォルト・パラメータ」でのステップ - 表示されるパラメータは、前のページで指定した「デフォルトRESTソース・タイプ」によって異なります。
   1. フィールドを編集します。パラメータの詳細はフィールドレベル・ヘルプを参照してください。
   2. 「作成」をクリックします。
   カタログが表示されます。

関連項目:

RESTデータ・ソース・タイプについて

17.4.7.3 RESTソース・カタログの編集

「RESTソース・カタログ」ページで、既存のRESTソース・カタログを編集します。

RESTソース・カタログを編集するには:

1. RESTソース・カタログ・ページにナビゲートします。
   1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
      アプリケーション・ビルダーのホームページが表示されます。
   2. 「ワークスペース・ユーティリティ」アイコンをクリックします。
   3. ワークスペース・ユーティリティ・ページで、「RESTソース・カタログ」をクリックします。
      RESTソース・カタログ・ページが表示されます。RESTソース・カタログは、グループと呼ばれるカテゴリに編成されます。
2. カタログ詳細を編集するには:
   1. カタログ名をクリックします。
      「RESTソース・カタログ詳細」ダイアログが表示されます。
   2. 対象となる属性を編集します。
      • グループ - カタログを編成し、サービスの作成時に開発者を支援するグループを選択します。
      • 名前 - カタログ名を編集します。カタログ名は、ワークスペースに対して一意であることが必要です。
      • 内部名 - 複数のAPEXインスタンスでカタログを識別します。カタログがインポートされ、同じ内部名のカタログがすでに存在する場合は、既存のカタログが上書きされます。
      • 説明 - RESTソース・カタログを説明します
      • エンドポイントURLのリフレッシュ - RESTソース・カタログをリフレッシュするには、カタログ・エクスポート・ファイルのダウンロード元のURLを指定します。
   3. 「変更の適用」をクリックします。
3. カタログを削除するには:
   1. カタログ名をクリックします。
   2. 「RESTソース・カタログ詳細」ダイアログで、「削除」をクリックします。
4. カタログ・サービスを表示するには:
   1. 「コンテンツ」列で、「サービス」ボタンをクリックします。
      カタログ・サービス・ページが表示されます。
   2. 特定のサービスに対して、サービス名をクリックします。

      サービス詳細が表示されます。

      カタログ・サービスの名前や説明などの記述データは編集できますが、その他のデータ・プロファイル、操作、パラメータなどの詳細は元のRESTデータ・ソース定義から編集してください。

5. 新しいRESTデータ・ソースをカタログに関連付けるには:
   1. 「RESTデータ・ソース」にナビゲートします。
   2. 「RESTソース・カタログ」で、「カタログに保存」をクリックします。
   3. 「RESTソース・カタログに保存」ダイアログでオプションを確認し、「カタログに保存」をクリックします。

17.4.7.4 カタログ・グループの管理

カタログ・グループを使用して、カタログをカテゴリに編成します。

カタログ・グループを管理するには:

1. RESTソース・カタログ・ページにナビゲートします。
   1. ワークスペースのホームページで、「アプリケーション・ビルダー」アイコンをクリックします。
      アプリケーション・ビルダーのホームページが表示されます。
   2. 「ワークスペース・ユーティリティ」アイコンをクリックします。
   3. ワークスペース・ユーティリティ・ページで、「RESTソース・カタログ」をクリックします。
      RESTソース・カタログ・ページが表示されます。
2. ページの右側にある「タスク」メニューから、「カタログ・グループの管理」をクリックします。
3. カタログ・グループを追加するには:
   1. 「グループの作成」をクリックします。
   2. 「カタログ・グループ詳細」ダイアログで、次の項目を指定します。

      • 名前 - カタログ・グループの名前を指定します。

      • 説明 - グループの目的を説明します。

      • 「作成」をクリックします。

4. カタログ・グループを編集するには:
   1. カタログ名をクリックします。
   2. 「カタログ・グループ詳細」ダイアログで、次の項目を指定します。

      • 名前 - カタログ・グループの名前を指定します。

      • 説明 - グループの目的を説明します。

      • 「変更の適用」をクリックします。

5. カタログ・グループを削除するには:
   1. カタログ名をクリックします。
   2. 「削除」をクリックします。

17.4.7.5 RESTソース・カタログのエクスポートおよびインポートについて

RESTソース・カタログをファイルにエクスポートし、そのファイルをターゲット・インスタンスにインポートして、これを別のインスタンスに移動します。

RESTソース・カタログを別のインスタンスにエクスポートするには、次のステップを実行します。

1. RESTソース・カタログを作成します。
2. RESTソース・カタログをエクスポートします。「RESTソース・カタログのエクスポート」を参照してください。
3. エクスポート・ファイルをターゲットのOracle APEXインスタンスにインポートします。「RESTソース・カタログのインポート」を参照してください。
4. 直接ファイルをインポートした後、または後でエクスポート・リポジトリから、エクスポートされたファイルをインストールします。「エクスポート・リポジトリからのその他ファイルのインストール」を参照してください。