ヘッダー
ヘッダー
REST API は標準の HTTP ヘッダーを使用して、要求と応答を装飾します。 広く使用されている要求ヘッダーは、次のとおりです。
| 名前 | 説明 |
|---|---|
| Accept | 目的のメディア形式を示します。 現時点では、application/json とする必要があります。 |
| If-None-Match | リソースの ETag ヘッダーが、送信されたいずれかの要求のヘッダー値と一致する場合は、この要求には 304 Not Modified 応答が返され、ローカルにキャッシュされたリソースが使用されます。 「キャッシュ」を参照してください。 |
| Content-Type | コンテンツが要求に含まれている場合は、使用されるメディア形式を表します。 現時点では、application/json のみがサポートされます。 |
| X-Auth-Token | 要求の認証に使用されます。 「認証」を参照してください。 |
これに対して返される主要な応答ヘッダーは、次のとおりです。
| 名前 | 説明 |
|---|---|
| Content-Type | 応答の本文で使用されるメディア形式です。 現時点では JSON のみがサポートされているため、常に application/json が返されます。 |
| ETag | リソースによって返される、リソースのバージョンを表す文字列です。ネットワーク帯域幅の使用を最適化するため、If-None-Match ヘッダーとともに使用します。 「キャッシュ」を参照してください。 |
| Location | 新規リソースを作成すると、サーバーは 201 Created 応答を返し、このヘッダーを使用して、新規作成したリソースの URL を提供します。 |
| X-Global-Identifier | 新規リソースを作成すると、サーバーは 201 Created 応答を返し、このヘッダー情報を使用して、新規作成したリソースのグローバル識別子を提供します。 |
簡潔化のため、リソースの詳細に関する以降のページでは、これらのヘッダーについての説明を省略しています。