ビューは、Data API Builder (DAB) のテーブルの代替としてサポートされています。 ビューは、最小限の構成で REST エンドポイントを介して公開できます。
コンフィギュレーション
ビューを公開するには:
-
source.typeを"view"に設定する -
source.objectを完全修飾ビュー名に設定する - 行を一意に識別するには、
key-fieldsを定義する -
"read"アクションを使用してアクセス許可を付与します (必要に応じて、ビューが更新可能な場合は、"create"、"update"、"delete")
CLI の例
dab add BookDetail \
--source dbo.vw_books_details \
--source.type "view" \
--fields.name "id" \
--fields.primary-key "true" \
--permissions "anonymous:read"
構成の例
"BookDetail": {
"source": {
"type": "view",
"object": "dbo.vw_books_details",
"key-fields": [ "id" ]
},
"permissions": [
{
"role": "anonymous",
"actions": [ "read" ]
}
]
}
REST の動作
- すべての REST 動詞、
GET、POST、PUT、PATCH、DELETEをサポートします。 - 既定の動作は、テーブルに基づくエンティティの場合と同一です
- ビューが更新可能で、適切なアクセス許可が設定されている場合にのみ、操作は成功します
要求の例
GET /api/BookDetail/id/42
vw_books_detailsおよびid = 42から行を返します。
アクセス許可
- 読み取り専用ビューに
readアクションを使用する - ビューが更新可能な場合にのみ、
create、update、およびdeleteを使用する
制限事項
-
key-fieldsは必須です - ビューはリレーションシップをサポートしていません
- ビューがテーブルのように動作する場合は、改ページ、フィルター処理、並べ替えがサポートされます