Použití zobrazení v Tvůrci rozhraní Data API

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

Konfigurace

Zveřejnění zobrazení:

• Nastavte source.type na hodnotu "view".
• Nastavit source.object na plně kvalifikovaný název zobrazení
• Definování key-fields pro jedinečnou identifikaci řádku
• 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" \
  --source.key-fields "id" \
  --permissions "anonymous:read"

Příklad konfigurace

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

Podpora 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/42

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

Podpora GraphQL

• Zobrazení se objeví jako typ GraphQL.
• Dotazy jsou vždy podporovány.
• Změny jsou podporovány pouze v případě, že je zobrazení aktualizovatelné.
• Řídí se standardní strukturou schématu DAB GraphQL.

Povolení

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

Omezení

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