Usando vistas no construtor de API de dados

As visualizações são suportadas como alternativas às tabelas no DAB. Uma vista pode ser exposta através de endpoints REST ou GraphQL com configuração mínima.

Configuração

Para mostrar uma vista:

• Defina source.type como "view"
• Definir source.object como o nome da vista totalmente qualificada
• Defina key-fields para identificar uma linha exclusivamente
• Conceder permissão usando a "read" ação (e, opcionalmente "create", "update", "delete" se a exibição for atualizável)

Exemplo de CLI

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

Exemplo de configuração

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

Suporte REST

• Suporta todos os verbos REST: GET, POST, PUT, PATCH, DELETE
• O comportamento padrão é idêntico às entidades baseadas em tabela
• As operações só serão bem-sucedidas se a exibição for atualizável e as permissões apropriadas forem definidas

Exemplo de pedido

GET /api/BookDetail/42

Devolve a linha a partir de vw_books_details com id = 42.

Suporte a GraphQL

• View aparece como um tipo GraphQL
• As consultas são sempre suportadas
• As mutações são suportadas apenas se a vista for atualizável
• Segue a estrutura padrão do esquema DAB GraphQL

Permissões

• Usar a ação read para visualizações somente leitura
• Use create, updatee delete somente se o modo de exibição for atualizável

Limitações

• key-fields são obrigatórios
• As visualizações não suportam relacionamentos
• A paginação, a filtragem e a classificação são suportadas se a exibição se comportar como uma tabela