Adatbázisnézetek a REST API-ban

A nézetek a Data API Builder (DAB) tábláinak alternatíváiként támogatottak. A nézet minimális konfigurációjú REST-végpontokon keresztül jeleníthető meg.

Konfiguráció

Nézet megjelenítése:

  • Állítsa be a source.type-t a "view"-re.
  • Állítsa be source.object a teljesen kiépített nézetnévre
  • Egy sor egyedi azonosításához definiálja a key-fields
  • Engedély megadása a "read" művelet használatával (és opcionálisan"create", "update""delete" ha a nézet frissíthető)

Példa parancssori felületre

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

Példa konfigurációra

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

REST-viselkedés

  • Támogatja az összes REST-igét: GET, POST, PUT, PATCHDELETE
  • Az alapértelmezett viselkedés megegyezik a táblák által támogatott entitásokkal
  • A műveletek csak akkor sikeresek, ha a nézet frissíthető, és a megfelelő engedélyek be vannak állítva

Példakérés

GET /api/BookDetail/id/42

Adja vissza a sort a következő feltételekkel: vw_books_details, id = 42.

Jogosultságok

  • A read művelet használata csak olvasható nézetekhez
  • Használja create, updateés delete csak akkor, ha a nézet frissíthető

Korlátozások

  • key-fields kötelező
  • A nézetek nem támogatják a kapcsolatokat
  • A lapozás, a szűrés és a rendezés akkor támogatott, ha a nézet táblázatként viselkedik