Jun's blog

仕事や趣味について綴ります

OData V4のバージョンヘッダについて

OData V4でのバージョンヘッダについて調べたのでメモ。
仕様書http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.pdf

OData-Version

  • ODataクライアントはリクエスト生成に使用したプロトコルのバージョンを指定するためにOData-Versionヘッダを使用すべきです。
  • サービス側ではリクエスト側が指定されたプロトコルバージョンで定義されたルールに従っていると解釈しなければならない。そうでないとリクエストは4xxのレスポンスコードで失敗します。
  • ODataサービスはレスポンス生成に使用したプロトコルのバージョンを指定するためにレスポンスにOData-Versionヘッダを含めなければなりません。
  • クライアント側はレンポンス側が指定されたプロトコルのバージョンで定義されたルールに従っていると解釈しなければなりません。

OData-MaxVersion

  • クライアントはOData-MaxVersionヘッダを指定すべきです。
  • クライアント側で受け入れ可能なプロトコルの最大バージョンを指定します。
  • このヘッダが指定された場合、サービス側は指定されたバージョン以下のOData-Versionでレスポンスを生成しなければいけません。指定されない場合、サービス側は「リクエストはサービスによってサポートされている最大バージョンと同じOData-MaxVersionを持っている」と解釈すべきです。

まとめ

  • OData-Versionはクライアント側、サービス側双方で正しく設定する
  • クライアント側はOData-MaxVersionも正しく設定しておいたほうが良い

以上。