HTTP ヘッダーの指定

特定の要求をカスタマイズするには、HTTP ヘッダーを設定する必要があります。 Content-Type ヘッダーと Accept ヘッダーは、入出力の形式を制御します。 Range ヘッダーはページ編集を制御します。 Compression ヘッダーは圧縮を制御します。

Content-Type ヘッダーと Accept ヘッダー

要求の本文と出力のコンテンツ・タイプを指定するには、Content-Type ヘッダーと Accept ヘッダーを使用します。

表 1. Content-Type ヘッダーと Accept ヘッダーの値
ヘッダー名	値	説明
`Content-Type`	`application/json`	要求の本文の形式が JSON であることを示します。
	`application/xml`	要求の本文の形式が XML であることを示します。
	`application/x-www-form-urlencoded`	要求の本文が URL エンコードであることを示します。
`Accept`	`application/json`	出力タイプを JSON に設定します。
	`application/json;indent=2`	出力タイプを定様式 JSON に設定します。
	`application/xml`	出力タイプを XML に設定します。

範囲

Range ヘッダーは、リスト API 呼び出しのページ編集を制御します。

表 2. Range ヘッダーの値
ヘッダー名	値	説明
`Range`	`items=x-y`	`x` から `y`までの行 ID を持つレコードを返します。あるいは、パラメーター `_range=x-y`を使用して、要求 URL に範囲を指定することもできます。

圧縮

応答内のデータを圧縮するには、Accept-Encoding ヘッダーを設定します。

テーブル3。 Compression ヘッダーの値
ヘッダー名	値	説明
`Accept-Encoding`	`gzip`	GNU .ZIP 形式で圧縮した結果を返します。
`Accept-Encoding`	`identity`	ID エンコードで結果を返します (変換なし)。

X-HTTP-Method-Override

要求の中で HTTP verb を使用できない場合は、その verb をオーバーライド・ヘッダーの値として指定して、POST 要求を送信します。要求は、あたかもオーバーライド・ヘッダーで示された HTTP verb を使用して呼び出しが行われたかのように動作します。

例えば、オーダー番号 12345 の DELETE 要求を渡すことができない場合は、X-HTTP-Method-Override ヘッダーを DELETE に設定して、次の HTTP 要求を使用します。

POST https://host:port/contextRoot/restapi/order/12345

X-HTTP-Method-Override ヘッダーを使用して、URL のサイズ制限を超える GET 要求のパラメーターを渡すこともできます。 URL に対して POST を実行し、Content-Type ヘッダーを application/x-www-form-urlencoded に設定して、X-HTTP-Method-Override ヘッダーを GET に設定します。

テーブル4。 X-HTTP-Method-Override ヘッダーの値
ヘッダー名	値
`X-HTTP-Method-Override`	`GET`
	`PATCH`
	`DELETE`