プライマリ・コンテンツに移動
Oracle® Application Express SQLワークショップ・ガイド
リリース5.1
E85938-02
目次へ移動
目次
索引へ移動
索引

前
次

6.6 RESTfulサービス・モジュールの管理

RESTfulサービス・モジュールは、一般的なテンプレート(リソース・テンプレートと呼ばれる)を共通のUniform Resource Identifier (URI)接頭辞でグループ化したものです。

URI接頭辞の指定はオプションです。RESTfulサービス・モジュールに接頭辞が定義されている場合は、その接頭辞がすべてのリソース・テンプレートの前に付きます。複数のリソース・テンプレートのパターンが1つのリクエストURIに一致する場合は、優先度の値を使用してリソース・テンプレートが選択されます。このような場合、優先度の値が最も高いリソース・テンプレートが選択されます。

6.6.1 サンプルのRESTfulサービス・モジュールのインストール

サンプルのRESTfulサービス・モジュールを作成する方法を学習します。

注意:

新規ワークスペースの作成時に、サンプルのRESTfulサービスのみをインストールできます。

サンプルのRESTfulサービス・モジュールを作成するには:

  1. ワークスペースのホームページで、「SQLワークショップ」をクリックして、「RESTfulサービス」をクリックします。

    「RESTfulサービス」ホームページが表示されます。

  2. 「サンプルのRESTfulサービスのインストール」をクリックします。
  3. 適切なフィールドに入力し、適切なオプションを選択します。必須フィールドには、赤いアスタリスク(*)が付いています。特定のオプションの詳細は、フィールドレベル・ヘルプを参照してください。
  4. RESTfulサービス・モジュールの設定で、次を指定します。
    • 名前(必須): RESTfulサービス・モジュールの名前を指定します。

    • URI接頭辞: URI接頭辞を指定します。

    • 使用可能な起点: リソース・テンプレートへのアクセスが許可される起点のカンマ区切りリストを指定します。

    • ステータス: このサービスを使用可能にする場合は「公開」を、しない場合は「未公開」を選択します。

    • ページ区切りサイズ: ページ区切りウィンドウのサイズを指定します。データベース問合せの場合、これは返される行の数です。

    • 必要な権限: このサービス・モジュールへのアクセスに必要なユーザー権限を選択します。

  5. このモジュールにリソース・テンプレートを追加するには、「リソース・テンプレートの追加」で次を指定します。
    • URIテンプレート: Uniform Resource Identifierを識別するURIテンプレートを入力します。URIテンプレートは、次に示すように、URIを記述する単純な構文です。

      example/{id}
      
    • 優先度: リソース・テンプレートの評価順序を指定します。高い数値から先に評価されます。

    • エンティティ・タグ: リソースのETag HTTPヘッダーの生成方法を指定します。詳細は、フィールドレベル・ヘルプを参照してください。

    • エンティティ・タグ問合せ: カスタム・エンティティ・タグの生成に使用される1つの列と1つの行を返すSQL SELECT文を指定します。このオプションは、「エンティティ・タグ」に「問合せ」を選択した場合にのみ表示されます。

  6. リソース・テンプレートにリソース・ハンドラを追加するには、「リソース・ハンドラの追加」で次を指定します。
    • 方法: リソース・ハンドラに使用するHTTPメソッドを指定します。オプションには、「GET」、「DELETE」、「POST」、「PUT」があります。詳細は、フィールドレベル・ヘルプを参照してください。

    • ソース・タイプ: 選択したHTTPメソッドのソース実装を選択します。オプションには、「問合せ」、「1行問い合せる」、「PL/SQL」、「フィード」、「メディア・リソース」があります。

    • 書式: 結果を返す方法を定義します。オプションには、「JSON」、「CSV」があります。

    • ソース: 選択したHTTPメソッドを処理するSQL問合せまたはPL/SQLブロックを指定します。

    注意:

    追加のリソース・ハンドラを定義するには、リソース・ハンドラの作成ウィザードを完了してから、作成したリソース・ハンドラを編集します。

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

    RESTfulサービス・モジュールのページが表示されます。

6.6.2 RESTfulサービス・モジュールの作成

RESTfulサービス・モジュールを作成する方法を学習します。

RESTfulサービス・モジュールを作成するには、次のステップを実行します。

  1. ワークスペースのホームページで、「SQLワークショップ」をクリックして、「RESTfulサービス」をクリックします。

    「RESTfulサービス」ホームページが表示されます。

  2. 「作成」をクリックします。
  3. 適切なフィールドに入力し、適切なオプションを選択します。必須フィールドには、赤いアスタリスク(*)が付いています。特定のオプションの詳細は、フィールドレベル・ヘルプを参照してください。
  4. RESTfulサービス・モジュールの設定で、次を指定します。
    • 名前(必須): RESTfulサービス・モジュールの名前を指定します。

    • URI接頭辞: URI接頭辞を指定します。

    • 使用可能な起点: リソース・テンプレートへのアクセスが許可される起点のカンマ区切りリストを指定します。

    • ステータス: このサービスを使用可能にする場合は「公開」を、しない場合は「未公開」を選択します。

    • ページ区切りサイズ: ページ区切りウィンドウのサイズを指定します。データベース問合せの場合、これは返される行の数です。

    • 必要な権限: このサービス・モジュールへのアクセスに必要なユーザー権限を選択します。

  5. このモジュールにリソース・テンプレートを追加するには、「リソース・テンプレートの追加」で次を指定します。
    • URIテンプレート: Uniform Resource Identifierを識別するURIテンプレートを入力します。URIテンプレートは、次に示すように、URIを記述する単純な構文です。

      example/{id}
      
    • 優先度: リソース・テンプレートの評価順序を指定します。高い数値から先に評価されます。

    • エンティティ・タグ: リソースのETag HTTPヘッダーの生成方法を指定します。詳細は、フィールドレベル・ヘルプを参照してください。

    • エンティティ・タグ問合せ: カスタム・エンティティ・タグの生成に使用される1つの列と1つの行を返すSQL SELECT文を指定します。このオプションは、「エンティティ・タグ」に「問合せ」を選択した場合にのみ表示されます。

  6. リソース・テンプレートにリソース・ハンドラを追加するには、「リソース・ハンドラの追加」で次を指定します。
    • 方法: リソース・ハンドラに使用するHTTPメソッドを指定します。オプションには、「GET」、「DELETE」、「POST」、「PUT」があります。詳細は、フィールドレベル・ヘルプを参照してください。

    • ソース・タイプ: 選択したHTTPメソッドのソース実装を選択します。オプションには、「問合せ」、「1行問い合せる」、「PL/SQL」、「フィード」、「メディア・リソース」があります。

    • 書式: 結果を返す方法を定義します。オプションには、「JSON」、「CSV」があります。

    • ソース: 選択したHTTPメソッドを処理するSQL問合せまたはPL/SQLブロックを指定します。

    注意:

    追加のリソース・ハンドラを定義するには、リソース・ハンドラの作成ウィザードを完了してから、作成したリソース・ハンドラを編集します。

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

    RESTfulサービス・モジュールのページが表示されます。

6.6.3 RESTfulサービス・モジュールの編集

RESTfulサービス・モジュールには、関連するリソース・テンプレートおよびリソース・ハンドラを含むことができます。特定のRESTfulサービス・モジュールの編集プロセス時に、関連する任意のリソース・テンプレートおよびリソース・ハンドラに変更を行うことができます。

RESTfulサービス・モジュールを編集するには、次のステップを実行します。

  1. ワークスペースのホームページで、「SQLワークショップ」をクリックして、「RESTfulサービス」をクリックします。

    「RESTfulサービス」ホームページが表示されます。

  2. 編集するモジュールの名前をクリックします。

    RESTfulサービス・モジュールの編集ページが表示されます。

    注意:

    リソース・テンプレートおよびリソース・ハンドラを表示、編集および作成するには、左のペインにあるRESTfulサービスのツリーを使用します。

  3. RESTfulサービス・モジュールの設定を編集するには、「RESTfulサービス・モジュール」の下で、右のペインのフィールドを変更します。

  4. リソース・テンプレートを編集するには、次のステップを実行します。

    1. 左のパネルにあるRESTfulサービスのツリーで、編集するリソース・テンプレートを選択します。リソース・テンプレートのオプションが右のパネルに表示されます。

    2. 変更を加えます。

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

  5. リソース・ハンドラを編集するには、次のステップを実行します。

    1. RESTfulサービスのツリーで、編集するリソース・ハンドラを選択します。リソース・ハンドラのオプションが右のパネルに表示されます。

    2. 変更を加えます。

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

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

6.6.4 RESTfulサービス・モジュールの削除

RESTfulサービス・モジュールを削除すると、モジュールとともに、このモジュールに関連するすべてのリソース・テンプレートおよびリソース・ハンドラが削除されます。

RESTfulサービス・モジュールを削除するには、次のステップを実行します。

  1. ワークスペースのホームページで、「SQLワークショップ」をクリックして、「RESTfulサービス」をクリックします。

    「RESTfulサービス」ホームページが表示されます。

  2. 削除するモジュールの名前をクリックします。

    RESTfulサービス・モジュールのページが表示されます。

  3. 「削除」をクリックします。
  4. 「OK」をクリックして確定します。

    「RESTfulサービス」ホームページが表示されます。

6.6.5 RESTfulサービス権限の管理

RESTfulサービス・モジュールにアクセスする権限は、Application Expressユーザー・グループに属するApplication Expressユーザーに限定することができます。

RESTfulサービス権限の割当てによってRESTfulサービス・モジュールを保護するには、次のステップを実行します。

  1. Application Express管理を使用してApplication Expressユーザー・グループを定義します。
  2. 1つ以上のユーザー・グループに基づくRESTfulサービス権限を作成します。
  3. この権限で保護されるRESTfulサービス・モジュールを指定します。

    関連項目:

6.6.6 RESTfulサービス・モジュールへの権限の割当て

RESTfulサービス・モジュールに権限を割り当てる方法を学習します。

RESTfulサービス・モジュールに権限を割り当てる方法は複数あります。

  • RESTfulサービス・モジュールの作成時または編集時に、モジュールに権限を指定できます。

  • RESTfulサービス権限の作成時または編集時に、この権限によって保護される1つ以上のモジュールを指定できます。

注意:

RESTfulサービス権限を削除すると、その権限によって保護されていたすべてのRESTfulサービス・モジュールが保護されなくなります。

6.6.7 RESTfulサービス権限の作成

RESTfulサービス権限を作成して、特定のユーザーに1つ以上のRESTfulサービス・モジュールへのアクセスを制限できます。

RESTfulサービス権限には、1つ以上のユーザー・グループに属するユーザーを含むことができます。この権限によって保護されるRESTfulサービス・モジュールでは、RESTfulサービス・モジュール・ページの「必要な権限」に、権限の名前が表示されます。

RESTfulサービス権限を作成するには、次のステップを実行します。

  1. ワークスペースのホームページで、「SQLワークショップ」をクリックして、「RESTfulサービス」をクリックします。

    「RESTfulサービス」ホームページが表示されます。

  2. 「タスク」で、「RESTfulサービス権限」リンクをクリックします。

    RESTfulサービス権限ページが表示されます。

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

    RESTfulサービス権限の詳細ページが表示されます。

  4. 「名前」に、権限を示す名前を入力します。
  5. 「ラベル」に、権限を示すラベル値を入力します。
  6. 「割当て済グループ」に、この権限の割当て先とするユーザー・グループを選択します。
  7. 「説明」に、この権限の説明を入力します。
  8. 「保護されたモジュール」で、矢印を使用して、この権限の割当て先とするモジュールを選択します。
  9. 「作成」をクリックします。

    RESTfulサービス権限ページが表示されます。

  10. 適切なモジュールに権限が割り当てられたことを確認するには、次のステップを実行します。
    1. ブレッドクラムで「RESTfulサービス」をクリックします。

      RESTfulサービス・ページが表示されます。

    2. 保護されている「RESTfulサービス・モジュール」をクリックします。

      RESTfulサービス・モジュールのページが表示されます。

    3. 「必要な権限」に、作成したRESTfulサービス権限が表示されることを確認します。

    4. この権限に割り当てられたすべてのモジュールが保護されていることを確認するには、これらの検証ステップを繰り返します。

6.6.8 RESTfulサービス権限の編集

RESTfulサービス権限は、変更できます。保護された特定のモジュールに対する変更は、影響を受けるモジュールのRESTfulサービス・モジュール・ページで、「必要な権限」設定に反映されます。

RESTfulサービス権限を編集するには、次のステップを実行します。

  1. ワークスペースのホームページで、「SQLワークショップ」をクリックして、「RESTfulサービス」をクリックします。

    「RESTfulサービス」ホームページが表示されます。

  2. 「タスク」で、「RESTfulサービス権限」リンクをクリックします。

    RESTfulサービス権限ページが表示されます。

  3. 「RESTfulサービス権限」をクリックします。

    RESTfulサービス権限の詳細ページが表示されます。

  4. 変更を加えます。
  5. 「変更の適用」をクリックします。

    RESTfulサービス権限ページが表示されます。

6.6.9 RESTfulサービス権限の削除

RESTfulサービス権限は、削除できます。権限を削除すると、その権限によって保護されていたすべてのRESTfulサービス・モジュールは、他の権限が再割当てされるまで保護されなくなります。

RESTfulサービス権限を削除するには、次のステップを実行します。

  1. ワークスペースのホームページで、「SQLワークショップ」をクリックして、「RESTfulサービス」をクリックします。

    「RESTfulサービス」ホームページが表示されます。

  2. 「タスク」で、「RESTfulサービス権限」リンクをクリックします。

    RESTfulサービス権限ページが表示されます。

  3. 「RESTfulサービス権限」をクリックします。

    RESTfulサービス権限の詳細ページが表示されます。

  4. 「削除」をクリックします。

    RESTfulサービス権限ページが表示されます。

6.6.10 RESTfulサービス・モジュールのエクスポート

RESTfulサービス・モジュールのメタデータは、SQLスクリプト形式でファイルにエクスポートできます。エクスポートされたファイルは、同じインスタンスまたは互換性のある他のApplication Expressインスタンスにインポートできます。

RESTfulサービス・モジュールをエクスポートするには、次のステップを実行します。

  1. ワークスペースのホームページで、「SQLワークショップ」をクリックして、「RESTfulサービス」をクリックします。

    「RESTfulサービス」ホームページが表示されます。

  2. 「タスク」で、「エクスポート」リンクをクリックします。

    RESTfulサービスのエクスポート・ページが表示されます。

  3. 「RESTfulサービス」で、次のいずれかを実行します。
    • 1つのモジュールをエクスポートするには、そのモジュール名を選択します。

    • すべてのモジュールをエクスポートするには、「すべてのサービス」を選択します。

  4. 「エクスポート」をクリックします。

    開始ダイアログが表示されます。

  5. エクスポート・オプションを選択します。
  6. 「OK」をクリックします。

6.6.11 RESTfulサービス・モジュールのインポート

SQLスクリプト形式でファイルにエクスポートされたRESTfulサービス・モジュールのメタデータは、インポートできます。インポートするモジュールは、同じインスタンスまたは互換性のある他のApplication Expressインスタンスにエクスポートされている必要があります。

注意:

インポートするモジュールに、このワークスペースに存在するRESTfulサービス名が含まれる場合は、既存のRESTfulサービスが削除され、インポートするモジュールの定義で置き換えられます。

RESTfulサービス・モジュールをインポートするには、次のステップを実行します。

  1. ワークスペースのホームページで、「SQLワークショップ」をクリックして、「RESTfulサービス」をクリックします。

    「RESTfulサービス」ホームページが表示されます。

  2. 「タスク」で、「インポート」リンクをクリックします。

    RESTfulサービスのインポート・ページが表示されます。

  3. 「ファイルのインポート」で、インポート・ファイルをブラウズして選択します。
  4. 「ファイルのキャラクタ・セット」で、インポート・ファイルで使用するキャラクタ・セットを選択します。
  5. 「インポート」をクリックします。

    RESTfulサービス・ページが表示されます。