Application Express 5.0でのRESTful Webサービスの作成および使用

サンプルのGETおよびPUTサービス・ハンドラを使用して「Employees」表にRESTful Webサービスを作成するには、次の手順を実行します。

1.  Oracle Application Expressの「Home」ページから「SQL Workshop」タブを選択し、「RESTful Services」を選択します。

   

2. 「Create >」をクリックします。

   

3. ページに、「RESTful Services Module」、「Resource Template」、「Resource Handler」という名前の3つのカテゴリにグループ化されたエントリが読み込まれます。「RESTful Services Module」で、「Name」にemployeesを入力し、さらに下方にスクロールします。

   

4. 「Resource Template」で、「URI Template」にemployees/を入力して自分のUniform Resource Identifier (URI)を特定し、さらに下方にスクロールします。

   

5. 「Resource Handler」で、「Method」に「GET」、「Source Type」に「Query」、「Format」に「CSV」を選択します。これにより、リソース・ハンドラによって使用されるHTTPメソッドが特定されます。
   「Source」に次のSQL問合せを入力し、「Create Module」をクリックします。
   
   select * from employees

   

6. 「GET」ハンドラが「employees/」の下に作成されます。そのプロパティを編集するには、「employees/」の下の「GET」をクリックします。

   

7. 「Requires Secure Access」に「No」を選択し、「Apply Changes」をクリックします。

   

8. RESTfulサービス・ハンドラの動作をテストするには、「Test」をクリックします。
   
   注意: 画面に「Test」ボタンが表示されない場合は、Oracle Application ExpressのインストールでRESTfulサービスが正しく構成されていることを確認してください。詳細は、「Oracle Application ExpressでのRESTfulサービスの構成手順」を参照してください。Database Cloud Serviceを使用している場合は、デフォルトでRESTfulサービスは構成されます。

   

9. ファイルを保存するように求められます。このファイルは後でCSVエディタを使用して表示できます。

   

10. CSV形式の結果セットが表示されます。

    

11. 次に、同じWebサービスでPOSTメソッドのハンドラを作成しましょう。「employees/」の下の「Create Handler」をクリックします。

    

12. 「Method」に「POST」、「Source Type」に「PL/SQL」を選択します。「MIME Types Allowed」にapplication/jsonを入力します。「Requires Secure Access」に「No」を選択します。「Source」に次のPL/SQLコードを入力し、「Create」をクリックします。
    
    declare
  id employees.employee_id%TYPE;
begin
  id := employees_seq.nextval;

  insert into employees
  (employee_id,first_name, last_name, email, hire_date, job_id)
  values
  id, :first_name, :last_name, :email, to_date(:hire_date, 'DD-MM-YYYY'),
  :job_id);

  :employee_id := id;
end;
    

    

13. ページを下方にスクロールし、「Create Parameter」をクリックして、新規作成されたemployeeのIDを返すハンドラにOUTパラメータを追加します。

    

14. 「Name」および「Bind Variable Name」にemployee_idを入力します。「Access Method」に「OUT」、「Source Type」に「HTTP Header」、「Parameter Type」に「String」を選択し、「Create」をクリックします。

    

15. OUTパラメータが作成されました。次のセクションでは、新規のテンプレートを作成し、バインド変数を使用して「Query One Row」に基づいてJSON結果セットを取得します。

    

このセクションでは、「employee id」を指定して「employee」の詳細情報を提供するRESTfulサービスを作成します。結果はJSON形式で返されます。次の手順を実行します。

1. 「Create Template」をクリックします。

   

2. 「URI Template」にemployees/{id}を入力し、「Create」をクリックします。

   

3. 「employees/{id}」の下の「Create Handler」をクリックします。

   

4. 「Method」に「GET」、「Source Type」に「Query One Row」、「Requires Secure Access」に「No」を選択します。
   「Source」に次のSQL問合せを入力し、「Create」をクリックします。
   
   select * from employees where employee_id = :id

   

5. さらに下方にスクロールし、「Create Parameter」をクリックして、「employee」のIDを受信するハンドラにINパラメータを追加します。

   

6. 「Name」および「Bind Variable Name」にidを入力します。「Access Method」に「IN」、「Source Type」に「HTTP Header」、「Parameter Type」に「String」を選択し、「Create」をクリックします。

   

7. 「Source Type」を変更します。「Parameters」の下で、「Name」の下の「id」リンクをクリックします。

   

8. 「Source Type」に「URI」を選択し、「Apply Changes」をクリックします。

   

9. このハンドラをテストする前に、バインド変数を設定して入力パラメータの値、idを渡します。「Set Bind Variables >」をクリックします。

   

10. 「:ID」に203を入力し、「Test」をクリックします。

    

11. 「employee_id = 203」の「employee」の完全な詳細が表示されます。

    

このセクションでは、フィード・ソース・タイプのRESTfulサービスを作成します。フィード結果はJSONとして表示されます。フィード内の各アイテムには、リソースのサマリーおよびリソースの完全表現へのハイパーリンクが含まれます。次の手順を実行します。

1. 「Create Template」をクリックします。

   

2. 「URI Template」にemployeesfeed/を入力し、「Create」をクリックします。

   

3. 「employeesfeed/」の下の「Create Handler」をクリックします。

   

4. 「Method」に「GET」、「Source Type」に「Feed」、「Requires Secure Access」「No」を選択します。「Source」の下に次のSQL問合せを入力し、「Create」をクリックします。
   
   select employee_id, first_name
from employees
order by employee_id, first_name

   

5. 「employeesfeed/」の下の「GET」をクリックし、「Resource Handler Editor」を開きます。

   

6. ページを下方にスクロールし、「Test」をクリックします。

   

7. 結果はJSON形式で表示されます。各アイテムは、RESTfulサービスからのベースURIを含んだURIと、パラメータとして使用される「employee_id」の値で構成されます。「Feed」ソース・タイプの場合、最初の列は一意の識別子でなければならず、このRESTfulサービスが呼び出される際にハイパーリンクに変換されます。
   この例では「employee_id」は最初の列で、ハイパーリンクに変換されます。
   
   たとえば、次のスクリーンショットでは、employee_id = 100の「employee」のURIは次のようになりますhttps://databasetrial7477:anjani.db.us2.oraclecloudapps.com/apex/employeesfeed/100

注意: この例に示されているURIは、このチュートリアルを実行するために使用されるデータベース・クラウド・サービスに固有のものであり、ユーザーのものとは異なる場合があります。また、URIの値も、このチュートリアルをオンプレミスか、クラウド・サービス上のどちらで実行しているかによって異なります。一般に、URI形式は次のようになります。

   オンプレミス	http://localhost:<Port where ords is set up>/ords/<schema name>/<Resource Template Name>/<employee_id> 例: http://localhost:9090/ords/apex/employeesfeed/100 この場合、ordsはOracle APEXのインストール中にポート9090で設定されており、apexはスキーマ名、employeesfeedはリソース・テンプレート名、100はemployee_idです。
   クラウド・サービス上	<Service URL as received in the Welcome email from Oracle Cloud>/<Resource Template Name>/<employee_id> 例: https://databasetrial7477:anjani.db.us2.oraclecloudapps.com/apex/employeesfeed/100 この場合、https://databasetrial7477:anjani.db.us2.oraclecloudapps.com/apex/は、このチュートリアルで使用されているクラウド・サービスのサブスクリプションのサービスURLで、employeesfeedはリソース・テンプレート名、100はemployee_idです。

   

8. いずれか1つのemployee_idのURIを選択し、クリップボードにコピーします。

   

9. ブラウザを開き、コピーしたURIをペーストし、[Enter]を押します。特定の「employee」の詳細がJSON結果セットとして返されます。

   

このセクションでは、Department IDを指定してフィード・ソース・タイプのRESTfulサービスを作成します。フィード結果はJSONとして表示されます。次の手順を実行します。

1. 「Create Template」をクリックします。

   

2. employeesfeed/{id},を入力し、「Create」をクリックします。

   

3. 「employeesfeed/{id},」の下の「Create Handler」をクリックします。

   

4. 「Method」に「Get」、「Source Type」に「Feed」、「Requires Secure Access」「No」を選択します。「Source」の下に次のSQL問合せを入力し、「Create」をクリックします。
   
   select employee_id, first_name
from employees
where department_id = :id

   

5. さらに下方にスクロールし、「Create Parameter」をクリックして、department_idを受信するハンドラにINパラメータを追加します。

   

6. 「Name」および「Bind Variable Name」にidを入力します。「Access Method」に「IN」、「Parameter Type」に「String」を選択し、「Create」をクリックします。

   

7. 「Source Type」を変更します。「Parameters」の下で、「Name」の下の「id」リンクをクリックします。

   

8. 「Source Type」に「URI」を選択し、「Apply Changes」をクリックします。

   

9. このハンドラをテストする前に、バインド変数を設定して入力パラメータの値、idを渡します。「Set Bind Variables >」をクリックします。

   

10. 「:ID」に 60 を入力し、「Test」をクリックします。

    

11. 結果はJSON形式で表示されます。各アイテムは、RESTfulサービスからのベースURIを含んだURIと、パラメータとして使用されるdepartment_idの値で構成されます。「Feed」ソース・タイプの場合、最初の列は一意の識別子でなければならず、このRESTfulサービスが呼び出される際にハイパーリンクに変換されます。
    この例では「department_id」は最初の列で、ハイパーリンクに変換されます。
    
    たとえば、次のスクリーンショットでは、「department_id = 60」の「employee」のURIは次のようになりますhttps://databasetrial7477:anjani.db.us2.oraclecloudapps.com/apex/employeesfeed/60?page=1この場合、page=1はこれらの結果は1ページ目に含まれることを意味します。結果セットに多数のレコードが存在する場合は、結果は2ページ目以降にまたがることになります。

    注意: この例に示されているURIは、このチュートリアルを実行するために使用されるデータベース・クラウド・サービスに固有のものであり、ユーザーのものとは異なる場合があります。また、URIの値も、このチュートリアルをオンプレミスか、クラウド・サービス上のどちらで実行しているかによって異なります。一般に、URI形式は次のようになります。

    オンプレミス	http://localhost:<Port where ords is set up>/ords/<schema name>/<Resource Template Name>/<department_id>?page=1 例: http://localhost:9090/ords/apex/employeesfeed/60?page=1 この場合、ordsはOracle APEXのインストール中にポート9090で設定されており、apexはスキーマ名、employeesfeedはリソース・テンプレート名、60はdepartment_idです。
    クラウド・サービス上	<Service URL as received in the Welcome email from Oracle Cloud>/<Resource Template Name>/<department_id>?page=1 例: https://databasetrial7477:anjani.db.us2.oraclecloudapps.com/apex/employeesfeed/60?page=1 この場合、https://databasetrial7477:anjani.db.us2.oraclecloudapps.com/apex/は、このチュートリアルで使用されているクラウド・サービスのサブスクリプションのサービスURLで、employeesfeedはリソース・テンプレート名、60はdepartment_idです。