Magic xpiトレーニングテキスト
13. 基本的なアダプタの使い方その4

13.1 Web Serviceとは

【Web Serviceとは】

  • インターネットに関連する技術を応用して、ソフトウェアの機能をネットワークを通じて利用できるようにするための技術、または、そのような形態で提供されるサービスのこと
  • 異なるOSや言語やツールでも利用可能であるのが特徴のひとつ
  • Webアプリケーションはブラウザなどを使用して人間が利用するものであるのに対して、Web Serviceはプログラムが利用するAPI
  • 古くからある高機能で複雑なSOAPと、昨今急速に普及してきたシンプルなRESTがある

 

【SOAPとは】

  • SOAPはSimple Object Access Protocolの略
  • リクエスト、レスポンスともにXMLフォーマットのデータで行う形式
  • SOAPのURLは操作と対応づけられるため、URLの命名が動詞的になることが多い

 

【RESTとは】

  • RESTはREpresentational State Transferの略
  • RESTの世界では、ネットワーク上のコンテンツ(リソース)を一意なURLで表すのが基本
  • 各リソース(URL)に対してGET、POST、PUT、DELETEでリクエストを送信し、レスポンスをXMLやJSONなどで受け取る形式(レスポンスのフォーマット形式は指定されていない)
  • RESTのURLはリソースと対応づけられるため、URLの命名が名詞的になることが多い

13.2 コンポーネントとサービス

  • xpiで使用できるWebサービス関連のコンポーネントは下記の通りです。
  • Web Servicesコンポーネントを使用する場合は、サービス「Magic xpi 4.13 Soap Service」の起動が必要です。
  • 次章の演習では、REST Clientコンポーネントを扱います。
種別 コンポーネント トリガ ステップ
SOAP Web Services ×
Web Services Client ×
WCF Client ×
REST REST Client ×

13.3 テスト用RESTサービスの準備

【テスト用RESTサービスの準備】 ※トレーニング用マシンでは準備されているので下記手順の実施は不要です。

  • REST Clientコンポーネントを使用するためには、接続先となるRESTサービスが必要です。
  • 次章の演習では、REST APIを備えたプロジェクト管理ソフトウェアRedmineを使用します。
  • Redmineの環境構築にはBitnamiを使用します。
【Redmineとは】
オープンソースのプロジェクト管理ソフトウェア
実施すべき作業、修正すべきバグなどの一つ一つのタスクをRedmineのプロジェクトにチケットとして登録します。

 

【Bitnamiとは】
さまざまなWebアプリケーション、Webサービスを構築する際、
必要となる言語やデータベースなどを、設定も含めて一つのインストーラで構築できます。

 

【BitnamiのRedmineインストール】

  • BitnamiのサイトからRedmineのインストーラをダウンロードし、インストールします。

BitnamiのRedmineインストール

https://bitnami.com/stack/redmine/installer

 

【Redmineの設定】

  • Redmineの管理画面にて下記の設定を行います。

Redmineの設定

No. 項目 使用方法
1 プロジェクト プロジェクト「勤怠管理システム開発」を作成
2 ユーザー 下記のユーザーを作成

No. ログインID 備考
1 xpi Admin Magic インストール時に作成するシステム管理者
2 developer1 Taro Magic

作成後、「勤怠管理システム開発」

プロジェクト、「開発者」ロールを割り当てる

3 developer2 Jiro Magic
3 トラッカー トラッカー「タスク」を作成
4 設定 設定>API>「RESTによるWebサービスを有効にする」にチェック

設定>認証>「認証が必要」を「はい」に設定

 

13.4 REST Clientコンポーネント

【REST Clientリソースの定義】

  • メニュー > プロジェクト > 設定よりREST Clientリソースを定義します。

EST Clientリソースの定義

 

【パスとパラメータの定義】

  • リソース設定画面で「パス」ボタンを押し、パス画面でパスとパラメータを定義します。

パスとパラメータの定義

 

【REST Clientコンポーネントの設定】

  • REST Clientコンポーネントをダブルクリックし、REST Client構成画面で設定します。

REST Clientコンポーネントの設定

 

【REST Clientコンポーネントの設定】

  • マッパ画面では、リクエストボディなどを設定します。

REST Clientコンポーネントの設定