Dela via

Databasvyer i REST-API:et

Vyer stöds som alternativ till tabeller i Data API Builder (DAB). En vy kan exponeras via REST-slutpunkter med minimal konfiguration.

Konfiguration

Så här visar du en vy:

  • Ställ in source.type på "view"
  • Ange source.object till det fullständigt kvalificerade vynamnet
  • Om du vill identifiera en rad unikt definierar du key-fields
  • Bevilja behörighet med hjälp av "read" åtgärden (och eventuellt "create", "update""delete" om vyn är uppdaterad)

CLI-exempel

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

Konfigurationsexempel

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

REST-beteende

  • Stöder alla REST-verb: GET, POST, PUT, , PATCHDELETE
  • Standardbeteendet är identiskt med tabellbaserade entiteter
  • Åtgärderna lyckas endast om vyn är uppdaterad och lämpliga behörigheter har angetts

Exempel på begäran

GET /api/BookDetail/id/42

Returnerar raden från vw_books_details med id = 42.

behörigheter

  • Använd åtgärden read för skrivskyddade vyer
  • Använd create, updateoch delete endast om vyn är uppdaterad

Begränsningar

  • key-fields krävs
  • Vyer stöder inte relationer
  • Sidnumrering, filtrering och sortering stöds om vyn fungerar som en tabell

Relaterat innehåll

  • Last updated on