Zobrazení databáze v rozhraní REST API

Zobrazení jsou podporována jako alternativy k tabulkám v aplikaci Data API Builder (DAB). Zobrazení je možné zpřístupnit prostřednictvím koncových bodů REST s minimální konfigurací.

Konfigurace

Zpřístupnit zobrazení:

  • Nastavte source.type na hodnotu "view".
  • Nastavit source.object na plně kvalifikovaný název zobrazení
  • Pokud chcete řádek identifikovat jedinečně, definujte key-fields
  • Udělení oprávnění pomocí "read" akce (a volitelně "create""update", "delete" pokud je zobrazení aktualizovatelné)

Příklad rozhraní příkazového řádku

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

Příklad konfigurace

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

Chování REST

  • Podporuje všechny příkazy REST: GET, POSTPUT, , PATCH,DELETE
  • Výchozí chování je stejné jako u entit založených na tabulce.
  • Operace jsou úspěšné pouze v případě, že je zobrazení aktualizovatelné a jsou nastavena příslušná oprávnění.

Příklad požadavku

GET /api/BookDetail/id/42

Vrátí řádek z vw_books_details s id = 42.

Povolení

  • Použijte akci read pro zobrazení jen pro čtení
  • Použití create, updatea delete pouze v případě, že je zobrazení aktualizovatelné

Omezení

  • key-fields je vyžadováno
  • Zobrazení nepodporují relace
  • Stránkování, filtrování a řazení se podporuje, pokud se zobrazení chová jako tabulka.

Související obsah

  • Last updated on