Vistas de base de datos en la API REST

Las vistas se admiten como alternativas a las tablas de Data API Builder (DAB). Una vista se puede exponer a través de puntos de conexión REST con una configuración mínima.

Configuración

Para exponer una vista:

  • Establezca source.type en "view".
  • Establézcalo source.object en el nombre completo de la vista.
  • Para identificar una fila de forma única, defina key-fields
  • Conceder permiso mediante la "read" acción (y, opcionalmente"create", , "update""delete" si la vista es actualizable)

Ejemplo de la CLI

dab add BookDetail \
  --source dbo.vw_books_details \
  --source.type "view" \
  --fields.name "id" \
  --fields.primary-key "true" \
  --permissions "anonymous:read"

Ejemplo de configuración

"BookDetail": {
  "source": {
    "type": "view",
    "object": "dbo.vw_books_details",
    "key-fields": [ "id" ]
  },
  "permissions": [
    {
      "role": "anonymous",
      "actions": [ "read" ]
    }
  ]
}

Comportamiento de REST

  • Admite todos los verbos REST: GET, POST, PUT, , PATCH, DELETE
  • El comportamiento predeterminado es idéntico a las entidades respaldadas por tablas
  • Las operaciones solo se realizan correctamente si la vista es actualizable y se establecen los permisos adecuados.

Solicitud de ejemplo

GET /api/BookDetail/id/42

Devuelve la fila de vw_books_details con id = 42.

Permisos

  • Uso de la read acción para vistas de solo lectura
  • Use create, updatey delete solo si la vista es actualizable

Limitaciones

  • key-fields son obligatorios
  • Las vistas no admiten relaciones
  • Se admiten la paginación, el filtrado y la ordenación si la vista se comporta como una tabla.

Contenido relacionado

  • Last updated on