最小限の読み取り専用実装のための OData 標準の概要

Question

の OData仕様 長い。「OData コア「文書はかなり長いです。

では、読み取り専用 OData パブリッシャーが最低限実装する必要があるものをまとめた要約はどうでしょうか?

Answer 1

始めます。OData サービスは、次のような HTTP エンドポイントを提供します。

• 理解しなければなりません」Accept" ヘッダー
• Content-Type ヘッダーをサポートしなければならず、ATOM 形式 (オプションで JSON) をサポートしなければなりません。
• サービス文書 (コレクションのリスト) を返すことができます (MAY)。 GET / (10.1.1)
  • ATOM（AtomPub?）形式の場合、階層は service/workspace/collection/title
• 次のようなリクエストにコレクションの説明を返さなければなりません GET /Customers (10.2)
  • ATOM の場合、階層は次のようになります。 feed/entry/content
• 次のようなリクエストに対して、個々のエンティティの説明を返さなければなりません。 GET /Customers(3) (10.2.1)
• 次のようなリクエストに対して、個々のエンティティの個々のプロパティを返す場合があります。 GET /Customers(3)/Name (10.2.2)
• を利用可能にしなければなりません CSDL EDMX ドキュメントにラップされたスキーマ記述 (10.1.2)
  • これは次の場所で入手できるはずです /$metadata
• これらのクエリのいずれかをサポートしてもよい (10.2.3)
  • フィルター (返される行を制限): Products?$filter=Price lt 10.00
  • 選択します (返されるフィールドを制限します): Products?$select=Rating,ReleaseDate
  • オーダーバイ: Products?$orderby=ReleaseDate asc, Rating desc
  • 先頭、スキップ: Products?$top=5&$skip=2
  • InlineCount (エンティティ数を含む): Products?$inlinecount=allpages
• エンティティ (10.2.4) の関係のリストを提供しなければなりません (?): Products(0)/$links/Orders
• エンティティ数を指定しなければなりません (10.2.5): Products/$count
• 他の形式をサポートしてもよい $format 指定子(10.2.3.7)

ATOM フィードが返されるとき (コレクションなど)、いくつかの OData 規則に準拠する必要があります。 http://www.odata.org/documentation/odata-v3-documentation/atom-format/ 例えば：

• 使用されるタイプは「edm:String」など。
• link 要素がふんだんに使われている
• content 要素には、インラインのコンテンツ (テキスト データなど) が含まれるか、それにリンクするコンテンツ (画像、バイナリ ファイルなど) が含まれます。 src= 属性。

JSON フィードが返されるときも、同様に特定のルールに従います。

• http://www.odata.org/documentation/odata-v3-documentation/json-verbose-format/

URL は次のスキームに従うことが推奨されます。

• http://www.odata.org/documentation/odata-v3-documentation/url-conventions/