コンテンツにスキップ

OData

OData は、自分で組み立てる HTTP としてではなく、独立したプロトコルとして扱われます。 Restorm はシステムクエリオプション、操作の種類、バッチ形式を理解しています。

ツリー内で右クリック ▸ 追加 ▸ OData リクエスト

クエリオプションのエディター($filter、$select、$top、$count、$orderby)と、下部に組み立てられた URL のプレビューを備えた OData タブ

フィールド役割
URLエンティティセットを含むサービスのエンドポイント
OData バージョンv2v3v4v4.01
操作の種類entity-setfunctionactionbatch
ヘッダー / パラメーターHTTP リクエストと同様

システムオプションにはそれぞれ専用のフィールドがあります。

$filter · $select · $top · $skip · $count · $expand · $orderby · $search · $formatjsonxmlatom)· $apply(集計、v4.01)。

$filter フィールドには、インポートしたメタデータをもとにした自動補完が働きます。 プロパティ名と演算子が候補として表示されます。

functionaction では、型付きの操作パラメーターのリストを利用できます (名前、修飾された CSDL 型、null 許容、バインディングの指定)。 アクションの場合は、専用の JSON ボディも使えます。

batch モードでは、サブリクエストのリストを持ちます。 各サブリクエストにはメソッド、URL、ヘッダー、ボディがあり、必要に応じてアトミック性グループchange set)も指定できます。オプションは 2 つあります。

  • 形式multipart(既定)または json
  • change set 内での GET を許可:既定では無効です。有効にすると警告が表示されます。 OData が想定していない使い方だからです。

$metadata または .edmx をインポートすると、Restorm はエンティティセットごとに CRUD リクエストを含むフォルダーを作り、さらに ActionsFunctions のフォルダーを作ります。 各リクエストにはエンティティ型、プロパティ、ナビゲーションプロパティ、クエリオプションが あらかじめ入力されています。 OData をインポートするを参照してください。

Restorm は OData v4 サービスのモックをホストできます。 メタデータの CSDL ドキュメント(そのまま配信されます)と、エンティティセットごとのデータを用意します。 システムクエリオプションは配信されるデータに適用されます。 OData サービスをシミュレートするを参照してください。