REST デバッガ ツール

［REST デバッガ］ への移動

［ツール｜REST デバッガ］

［REST デバッガ］は、アドホックに要求を行うためのツールです。TRESTDataSetAdapter コンポーネントおよび TClientDataSet コンポーネントによって、JSON 表現をデータセットに変換します。

このツールでは、さまざまな認証方式を使って Google API や Twitter などのサービスに接続することができます。指定されたサービスに要求を送信し、応答を表示することができます。

［要求］ペイン

［要求］

［要求］タブを使用して、TRESTClient および TRESTRequest のプロパティを指定することができます。

項目	説明
［メソッド］	TRESTRequest メソッドを次のように一覧表示します： POST - 処理対象のデータを TRESTRequest リソースに送信。 PUT - TRESTRequest リソースのデータを更新。 GET - TRESTRequest リソースのデータを要求。 DELETE - データを TRESTRequest リソースから削除。 PATCH -- PATCH 本体に含めて送信されたペアのみを更新することで、TRESTRequest リソースのデータの一部を変更する。
［URL］	TRESTClient の BaseURL プロパティを指定します。BaseURL プロパティは、要求 URL 全体の前半部分です。 ヒント： このフィールドで Enter を押すと、要求が送信されます。「要求の送信」を参照してください。
［コンテンツ タイプ］	TRESTRequestParameterList の ContentType プロパティを指定します。
［カスタム本体］	TRESTRequestParameterList の CustomBody プロパティを指定します。

［パラメータ］

［パラメータ］タブを使用して、サービスで実行される実際のアクションと TRESTRequest パラメータを定義することができます。

項目	説明
［リソース］	TRESTRequest の Resource プロパティを指定します。 Resource プロパティは、要求 URL 全体の後半部分であり、実際のクエリ文字列を表します。
［要求パラメータ］	TRESTRequest パラメータを指定します。パラメータにはいくつかの種類があります： ［ヘッダー］パラメータ - 「キー=値」という形式で、要求の HTTP ヘッダーに埋め込まれます。 ［GET/POST］パラメータ - 「キー=値」という形式です。 HTTP POST 要求の場合、POST パラメータは要求の本体に埋め込まれます。 HTTP GET 要求の場合、GET パラメータはクエリ文字列の一部として URL に埋め込まれます。 ［本体］パラメータ - 1 つの値だけで構成され、TRESTRequest 本体の中に統合されます。 ［URL セグメント］パラメータ - 「キー=値」という形式で、値は、HTTP URL の、要求のクエリ文字列の前に付け足されます。 複数の［URL セグメント］パラメータを指定するときには、バックスラッシュ（\）で区切ります。 ［クッキー］パラメータ - 「キー=値」という形式で、クッキー値として送信されます。
［追加］	TRESTRequest パラメータ リストに新しいパラメータを追加します。［種類］の ComboBox でパラメータの種類を、［名前］のTComboEdit でパラメータ名を、［値］の TEdit でパラメータ値を、それぞれ指定します。
［編集］	TRESTRequest パラメータ リストのパラメータを編集します。選択したパラメータの種類や名前や値を変更します。
［削除］	TRESTRequest パラメータ リストで選択したパラメータを削除します。

［認証］

ほとんどのサービスでは認証が必要です。1 つの認証クラスがクライアントに添付され、完結した要求ごとに自動的に実行されます。

項目	説明
［メソッド］	REST クライアントに添付される標準の認証クラスを指定します。 ［なし］ - サービスで認証が必要ない場合に使用します。 デフォルトで、TRestClient の認証方式は amNONE です。 ［単純］ - HTML フォームなどの基本認証をまねたものです。 TSimpleAuthenticator では、［ユーザー名］と［パスワード］の値およびキー名が必要です。 ［基本］ - HTTP 基本認証を指します。 THTTPBasicAuthenticator では、［ユーザー名］と［パスワード］を要求の HTTP ヘッダーに埋め込む必要があります。 ［OAUTH］ - ユーザーとの相互作用が必要になる方式です。 TOAuth1Authenticator を使用するアプリケーションでは、サービス プロバイダからトークンを受け取り、そのトークンを使ってサービスにアクセスしなければなりません。 ［OAUTH2］ - サービス プロバイダからトークンを受け取り、そのトークンを使ってサービスにアクセスしなければなりません。 TOAuth1Authenticator と違って、TOAuth2Authenticator では HTTPS のセキュリティを利用するので、要求に署名する必要はなくなります。
［ユーザー名］	TRESTRequestParameterList の AuthUsername プロパティを表します。［ユーザー名］ TEdit は、認証方式が 単純 および 基本 のときに有効になります。
［パスワード］	TRESTRequestParameterList の AuthPassword プロパティを表します。 ［パスワード］ TEdit は、認証方式が 単純 および 基本 のときに有効になります。
［ユーザー名のキー］	TRESTRequestParameterList の AuthUsernameKey プロパティを表します。［ユーザー名のキー］ TEdit は、認証方式が 単純 のときに有効になります。
［パスワードのキー］	TRESTRequestParameterList の AuthPasswordKey プロパティを表します。 ［パスワードのキー］ TEdit は、認証方式が 単純 のときに有効になります。
［クライアント ID］	TRESTRequestParameterList の ClientID プロパティを表します。 ［クライアント-ID］ TEdit は、OAUTH および OAUTH2 の方式の場合に有効になります。
［クライアント シークレット］	TRESTRequestParameterList の ClientSecret プロパティを表します。 ［クライアント シークレット］ TEdit は、OAUTH および OAUTH2 の方式の場合に有効になります。
［アクセス トークン］	TRESTRequestParameterList の AccessToken プロパティを表します。 ［アクセス トークン］ TEdit は、OAUTH および OAUTH2 の方式の場合に有効になります。
［要求トークン］	TRESTRequestParameterList の AccessTokenSecret プロパティを表します。 ［要求トークン］ TEdit は、OAUTH および OAUTH2 の方式の場合に有効になります。
［OAuth アシスタント］	OAUTH または OAUTH2 方式のすべてのパラメータ値を持つ、新しいウィンドウを開きます。新しく開いたこのウィンドウには、［認証］のメイン ページにないフィールドも含まれていて、Google や Twitter などのさまざまなサービスを使用することができます。

［接続］

［接続］タブを使用して、TRESTClient のプロキシ関連のプロパティを指定することができます。

項目	説明
［プロキシ サーバーを使用する］	［プロキシ サーバーを使用する］ TCheckBox にチェックをつけるか、チェックなしのままにすることで、TRESTClient がプロキシ サーバーを処理するかどうかを指定します。
［プロキシ サーバー］	TRESTClient の ProxyServer プロパティを指定します。
［プロキシ ポート］	TRESTClient の ProxyPort プロパティを指定します。ProxyPort のデフォルト値は 0 です。
［ユーザー名］	TRESTClient の ProxyUsername プロパティを指定します。
［パスワード］	TRESTClient の ProxyPassword プロパティを指定します。

要求関連のボタン

項目	説明
［要求の送信］	必要に応じてプロキシ サーバーを設定し、プロパティ BaseURL および Resource と、TRESTRequest メソッドを定義します。［要求の送信］ボタンをクリックすると、TRESTRequest が実行され、応答が表示されます。
［要求の新規作成］	［要求］、［パラメータ］、［認証］、［接続］の各ページの フィールドがデフォルト値にリセットされます。
［要求の読み込み］	TOpenDialog コンポーネントを使用して、選択したファイルから TRESTClient、TRESTRequest、または TRESTResponse のプロパティ値を読み込みます。
［要求の保存］	TRESTClient、TRESTRequest、TRESTResponse コンポーネントのプロパティ値をファイルに保存します。
［コンポーネントのコピー］	TRESTClient、TRESTRequest、および TRESTResponse コンポーネントをクリップボードにコピーします。これらのコンポーネントをクリップボードにコピーし、その後、フォーム デザイナに貼り付けることができます。

［応答］ペイン

［応答］ページを使用して、サービスから返されたデータを TRESTResponse クラス経由で読み取ることができます。

この TGroupBox には、サービスから受け取った応答を表示する 3 つのラベルがあります。直近の要求の URL と直近の要求の状態のラベルは TGroupBox のすぐ上に、プロキシの状態のラベルは TGroupBox の下にあります。

項目	説明
直近の要求の URL	TRESTClient の BaseURL プロパティが表示されます。
直近の要求の状態	以下についての情報が含まれます。 応答の状態 - TRESTResponse の StatusCode、StatusText、ContentLength の各プロパティが表示されます。 実行パフォーマンス - 以下の計時情報が表示されます。</li> 前処理時間 ： 実行を開始してから、要求を実際の HTTP クライアントに渡してサーバーに送信するまでの時間。 実行時間 ： 要求をサーバーに送信してから応答を受け取るまでの時間。 後処理時間 ： サーバー応答を受け取ってからすべての後処理が終了するまでの時間（JSON の解析を含む）。 合計実行時間 ： 実行時間の合計 - 前処理時間、実行時間、後処理時間 の合計
プロキシの状態	ProxyServer が有効かどうかを示します。

［ヘッダー］

応答ヘッダーには、「キー=値」のペアとして、サーバーがクライアントに送信したファイルの日付やサイズや種類、また、サーバー自体のデータなどの情報が含まれています。

サーバーが取得する HTTP ヘッダー フィールドは、API によって異なります。

項目	説明
応答ヘッダー	TRESTResponse の Headers プロパティが表示されます。

［本体］

応答には、サービスから返されたすべてのデータが保持されます。このデータには、HTTP ステータス コードやエラー メッセージ（あれば）、返された JSON データが含まれます。

応答データには、Content、JSONValue、RAWbytes のいずれかのプロパティを使ってアクセスすることができます。

項目	説明
JSON ラベル	以下を示します。 内容が JSON 表現であるかどうか。 JSON ルート要素が無効なものであるか。
JSON ルート要素	TRESTResponse の RootElement プロパティを表します。必要なルート要素を ［JSON ルート要素］ TClearingEdit に入力してください。
応答本体	ヘッダーの直後にある、サービスから返されたすべてのデータが表示されます。
適用	RootElement プロパティを基に、表示する応答本体の内容を制限します。

表データ

サービスから返される JSON 形式の応答は、データセット アダプタを持つ TDataSet の任意の下位クラスに変換することができます。

各 JSON オブジェクトはデータセット内の新しいレコードになります。JSON オブジェクトのプロパティは、通常、データセットの列になります。

項目	説明
文字列グリッド	応答をデータセットとして整理したものが表示されます。

前のトピック

REST デバッガのインストール

次のトピック

［REST デバッガ］の使用