#Fonte de dados REST API

#Introdução

Usado para conectar dados provenientes de uma REST API.

#Instalação

Este plugin é comercial. Para obter detalhes sobre como ativá-lo, consulte: Guia de ativação de plugins comerciais

#Adicionar uma fonte REST API

Depois de ativar o plugin, selecione REST API no menu suspenso Add new do gerenciamento de fontes de dados.

Configurar uma fonte REST API

#Adicionar uma Collection

Os recursos RESTful correspondem às Collections do NocoBase, como o recurso Users.

GET /users
POST /users
GET /users/1
PUT /users/1
DELETE /users/1

A configuração correspondente na API do NocoBase é

GET /users:list
POST /users:create
POST /users:get?filterByTk=1
POST /users:update?filterByTk=1
POST /users:destroy?filterByTk=1

Para consultar a especificação completa de design da API do NocoBase, consulte a documentação da API.

Consulte a seção “NocoBase API - Core”

A configuração da Collection da fonte de dados REST API é a seguinte

#List

Configure o mapeamento da interface para consultar a lista de recursos

#Get

Configure o mapeamento da interface para consultar os detalhes de um recurso

#Create

Configure o mapeamento da interface para criar um recurso

#Update

Configure o mapeamento da interface para atualizar um recurso

#Destroy

Configure o mapeamento da interface para excluir um recurso

As interfaces List e Get são obrigatórias.

#Depurar a API

#Integração dos parâmetros da solicitação

Exemplo: configure parâmetros de paginação para a interface List (se a API de terceiros não oferecer suporte à paginação, os dados da lista obtidos serão paginados).

Observe que somente as variáveis já adicionadas à interface entrarão em vigor.

Clique em Try it out para depurar e visualizar o resultado da resposta.

#Conversão do formato da resposta

O formato da resposta da API de terceiros pode não estar em conformidade com o padrão do NocoBase. É necessário convertê-lo para que seja exibido corretamente no frontend.

Ajuste as regras de conversão de acordo com o formato da resposta da API de terceiros, para que estejam em conformidade com o padrão de saída do NocoBase.

Descrição do processo de depuração

#Conversão das informações de erro

Quando ocorre um erro na API de terceiros, o formato das informações de erro na resposta pode não estar em conformidade com o padrão do NocoBase. É necessário convertê-lo para que seja exibido corretamente no frontend.

Quando a conversão das informações de erro não está configurada, por padrão elas são convertidas em informações de erro que incluem o código de status HTTP.

Depois de configurar a conversão das informações de erro, elas passam a estar em conformidade com o padrão de saída do NocoBase, permitindo que o frontend exiba corretamente as informações de erro da API de terceiros.

#Variáveis

A fonte de dados REST API fornece três tipos de variáveis para a integração com as interfaces

• Variáveis personalizadas da fonte de dados
• Solicitação do NocoBase
• Resposta de terceiros

#Variáveis personalizadas da fonte de dados

#Solicitação do NocoBase

• Params: parâmetros de consulta da URL (Search Params); os Params variam de acordo com a interface;
• Headers: corpo da solicitação, usado principalmente para fornecer algumas informações personalizadas do NocoBase com o prefixo X-;
• Body: corpo da solicitação;
• Token: token de API da solicitação atual do NocoBase.

#Resposta de terceiros

Atualmente, somente o Body da resposta é fornecido

As variáveis disponíveis para a integração com cada interface são as seguintes:

#List

#Get

#Create

#Update

#Destroy

#Configurar campos

Extraia os metadados dos campos (Fields) dos dados das interfaces CRUD do recurso adaptado e use-os como campos da collection.

Extrair metadados dos campos.

Campos e visualização.

Editar campos (de forma semelhante a outras fontes de dados).

#Adicionar um bloco da fonte de dados REST API

Depois de configurar a Collection, você poderá adicionar blocos à interface.