RESTでデータベース検索のWebサービスを実行し、XML型の検索結果を取得したい

キーワード:Webサービス,Webアプリケーション,REST,RESTアダプタ,GET,POST
シナリオ一覧に戻る

概要

RESTでWebサービスを実行して、XMLの戻り値を取得したい場合、RESTアダプタを使用します。

サンプルプロジェクトの説明

RESTでWebサービスを実行し、Webサービスからの戻り値をファイルに出力します。
本スクリプトは逆引きリファレンス「データベースを検索して、複数件の結果を返す処理をRESTのWebサービスとして公開したい」をWebサービスとして呼び出します。

処理の流れ

サンプルプロジェクトの処理の流れは以下の通りです。
  1. GET実行処理」を使用してWebサービスに対してHTTPのGETメソッドでリクエストを実行します。
  2. XMLファイル書き込み処理」でWebサービスの実行結果をファイルに書き込みます。
実行結果のイメージについては、サンプルプロジェクトのサンプルデータ「output.xml」を参照してください。

ポイントとなる機能

名前 説明 ツールパレット上の場所
GET実行処理 HTTPのGETメソッドでリクエストを実行します。 「ネットワーク」-「REST」-「GET実行」

処理のポイント

RESTアダプタは次のHTTPメソッドに対応しています。

メソッド 対応するオペレーション
GET GET実行処理
POST POST実行処理
PUT PUT実行処理
DELETE DELETE実行処理

レスポンスのデータ形式は「XML」・「JSON」・「その他のデータ形式」から選択できます。
XML形式のデータを取得したい場合、各オペレーションの[レスポンス設定]タブの[データ形式]に「XML」を選択してください。

サンプルプロジェクトの使用方法

上記処理を実装したサンプルプロジェクトを用意しています。サンプルプロジェクトを使用する場合の手順は、以下の通りです。

サンプルプロジェクトファイル名 rl_reference_070.zip
  1. サンプルプロジェクトの展開
    サンプルプロジェクトファイル「rl_reference_070.zip」を展開します。

  2. プロジェクトのアップロード
    「rl_reference_070.zip」を展開後に作成される「rl_reference_070プロジェクト」ディレクトリがプロジェクトファイルとなります。
    DataSpider Studioを起動し、マイプロジェクトの画面から[ファイル]-[ローカルからアップロード]で展開したディレクトリ「rl_reference_070プロジェクト」をアップロードしてください。

  3. サンプルデータの準備
    「rl_reference_070.zip」を展開後に作成される「samples」ディレクトリがサンプルデータとなります。
    $DATASPIDER_HOME/server/samplesディレクトリに上書きしてください。

  4. Webサービスの公開
    本スクリプトで呼び出すWebサービスを公開します。
    Webサービスの公開方法については、逆引きリファレンス「データベースを検索して、複数件の結果を返す処理をRESTのWebサービスとして公開したい」を参照してください。

  5. グローバルリソースの設定
    コントロールパネルの[グローバルリソースの設定]から、[新しいグローバルリソースの追加]を選択し、REST接続設定のグローバルリソースを追加します。
    グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。

スクリプトの作成手順

プロセスフローおよびデータフローは、「サンプルプロジェクトの説明」のスクリプト画像を参照して適宜設定してください。
  1. デザイナのツールパレット「ネットワーク」-「REST」-「GET実行」から、GET実行処理をスクリプトキャンバスに配置します。

  2. デザイナのツールパレット「ファイル」-「XML」-「XMLファイル書き込み」から、XMLファイル書き込み処理をスクリプトキャンバスに配置します。

  3. スクリプトを実行し、正常終了すれば成功です。