Представления базы данных в REST API

Представления поддерживаются в качестве альтернативы таблицам в построителе API данных (DAB). Представление может быть предоставлено через конечные точки REST с минимальной конфигурацией.

Конфигурация

Чтобы отобразить вид, выполните следующие действия.

  • Установите source.type на "view"
  • Задайте source.object полное имя представления
  • Чтобы определить строку уникально, определите key-fields
  • Предоставьте разрешение с помощью "read" действия (при необходимости"create", "update""delete"если представление обновляется)

Пример интерфейса командной строки

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, PUTPATCHDELETE
  • Поведение по умолчанию идентично сущностям, поддерживаемым таблицами
  • Операции выполняются успешно, только если представление обновляется и заданы соответствующие разрешения

Пример запроса

GET /api/BookDetail/id/42

Возвращает строку из vw_books_details с id = 42.

Разрешения

  • Использование действия read для представлений только для чтения
  • Использование create, updateи delete только если представление является обновляемым

Ограничения

  • key-fields обязательны
  • Представления не поддерживают связи
  • Разбиение на страницы, фильтрация и сортировка поддерживаются, если представление работает как таблица

Связанный контент

  • Last updated on