RAD サーバー エンドポイント

RAD サーバー管理コンソール アプリケーションの利用 への移動

RAD サーバー管理コンソール アプリケーションでは、REST デバッガを介して、RAD サーバー REST API にクエリをかけ、JSON レスポンスを確認し、異なるパラメータや HTTP メソッドでテストすることができます。

メニュー

RAD サーバー管理コンソール アプリケーションで、エンドポイント オプションのメニュー オプションを使用して、要求を管理するには：

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

［要求］

要求 セクションを使用して、プロパティ TRESTClient および TRESTRequest を指定することができます。

［メソッド］

TRESTRequest メソッドを次のように一覧表示します：
POST - 処理対象のデータを TRESTRequest リソースに送信。
PUT - TRESTRequest リソースのデータを更新。
GET - TRESTRequest リソースのデータを要求。
DELETE - データを TRESTRequest リソースから削除。
PATCH -- PATCH 本体に含めて送信されたペアのみを更新することで、TRESTRequest リソースのデータの一部を変更する。

［エンドポイント］

RAD サーバー上のカスタム エンドポイントで自動的に設定されます。

［コンテンツ タイプ］

TRESTRequestParameterList のContentType プロパティを示します。

• application/atom+xml
• application/json
• application/vnd.embarcadero.firedac+json
• application/xml
• application/x-www-form-urlendcode
• text/html

［要求パラメータ］

TRESTRequest パラメータを指定します。 パラメータにはいくつかの種類があります：
［ヘッダー］パラメータ - 「キー=値」という形式で、要求の HTTP ヘッダーに埋め込まれます。
［GET/POST］パラメータ - 「キー=値」という形式です。 HTTP POST 要求の場合、POST パラメータは要求の本体に埋め込まれます。 HTTP GET 要求の場合、GET パラメータはクエリ文字列の一部として URL に埋め込まれます。
［本体］パラメータ - 1 つの値だけで構成され、TRESTRequest 本体の中に統合されます。
［URL セグメント］パラメータ - 「キー=値」という形式で、値は、HTTP URL の、要求のクエリ文字列の前に付け足されます。 複数の［URL セグメント］パラメータを指定するときには、バックスラッシュ（\）で区切ります。
［クッキー］パラメータ - 「キー=値」という形式で、クッキー値として送信されます。

［追加］

新しいパラメータを TRESTRequest パラメータ リストに追加します。パラメータのタイプを ［種類］ ComboBox を使用し、パラメータ名を ［名前］ TComboEdit に、パラメータ値を ［値］ TEdit に指定します。

［編集］

TRESTRequest パラメータ リストのパラメータを編集します。選択されたパラメータの種類、名前、値を変更します。

［削除］

TRESTRequest パラメータ リストで選択したパラメータを削除します。

［カスタム本体］

TRESTRequestParameterList の CustomBody プロパティを指定します。

［応答］

［ヘッダー］

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

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

項目	説明
応答ヘッダー	TRESTResponse の ［ヘッダー］プロパティを表示

［本体］

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

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

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

［表データ］

サービスの整形済み応答の JSON は、データセット アダプタで TDataSet の下位クラスに変換することができます。

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

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

関連項目

• RAD サーバー エンジン（EMS サーバー）
• ［REST デバッガ］ツール