5.4.5.2. ユーザ定義（REST）の詳細¶

5.4.5.2.1.1. 本チュートリアルで定義する仮想のサービス提供者とその詳細¶

図：仮想のサービス提供者のイメージ

設定項目	想定する値/設定内容
エンドポイント	http://example.org/rest/api
メソッド	POST
リクエストパラメータ	以下の二つのパラメータを受け取ることができるものとします。 max_count 取得データの上限個数を指定します。 型は数値型を取るものとします。 search_word 取得データを部分一致で検索する単語を指定します。 型は文字列型を取るものとします。
入力様式	x-www-form-urlencoded
出力様式	json
認証方式	OAuth2を利用した認証を利用します。

5.4.5.2.2.1. 基礎情報¶

• エンドポイント

  • http://example.org/rest/api

• メソッド

  • POST

• リクエスト種別

  • x-www-form-urlencoded

• リクエストエンコーディング

  • UTF-8

• リダイレクトを利用する

  • チェックあり

• リクエストタイムアウト（秒）

  • 30

図：リクエスト情報 - 基礎情報

5.4.5.2.2.2. リクエストヘッダ¶

1. リクエストヘッダの初期値であるUser-Agentヘッダの行の右にある削除アイコンをクリックします。

   

   図：ヘッダの削除その1

2. User-Agentヘッダが削除されます。

   

   図：ヘッダの削除その2

3. ヘッダ情報を扱うテーブルの左上にある追加アイコンをクリックし、新しい行を追加します。

   

   図：ヘッダの追加その1

4. 追加された行に以下の値を入力します。

   • ヘッダ名 「Authorization」
   • ヘッダ値 「Bearer iNtRaMaRt」

   

   図：ヘッダの追加その2

5.4.5.2.2.3. リクエストパラメータ¶

1. リクエストパラメータの初期値であるParam1パラメータ名の行の右にある削除アイコンをクリックします。

   

   図：パラメータの削除その1

2. Param1パラメータが削除されます。

   

   図：パラメータの削除その2

3. 同様の方法でParam2パラメータの行も削除します。

   

   図：パラメータの削除その3

4. パラメータ情報を扱うテーブルの左上にある追加アイコンをクリックし、新しい行を追加します。

   

   図：パラメータの追加その1

5. 追加された行に以下の値を入力します。

   • パラメータ名 「max_count」
   • パラメータ値 「10」

   

   図：パラメータの追加その2（max_count）

6. 同様の手順で新しく行を追加し、以下の値を入力します。

   • パラメータ名 「search_word」
   • パラメータ値 「logic-designer」

   

   図：パラメータの追加その3（search_word）

5.4.5.2.4.1. 入力値¶

1. 入力値として以下の項目を設定します。

   入力値	説明
   max_count<integer>	リクエストパラメータの「max_count」に紐づける入力値。
   search_word<string>	リクエストパラメータの「search_word」に紐づける入力値。

2. リクエストパラメータに定義した「max_count」、および、「search_word」のパラメータ値を削除します。

   

   図：定義済みのパラメータ値の削除

3. 新しく以下のパラメータ値を定義します。

   • パラメータ名 「max_count」- パラメータ値 「${max_count}」
   • パラメータ名 「search_word」- パラメータ値 「${search_word}」

   

   図：新規パラメータ（EL式）の追加

5.4.5.2.4.2. 出力値¶

出力値	説明
status<object> - statusCode<integer>	HTTPステータスコードが格納されます。
status<object> - reasonPhrase<string>	HTTPステータスコードに基づく原因を表す文字列が格納されます
headers<map>	ヘッダ情報が格納されます。
body<object>	実行結果（HTTPレスポンスの本体）