Esta documentação foi traduzida automaticamente por IA.
Fonte de Dados REST API
This feature is provided by the commercial plugin «Fonte de dados: REST API», please purchase to useIntrodução
Este plugin permite que você integre dados de fontes REST API de forma fluida.
Instalação
Por ser um plugin comercial, você precisará fazer o upload e ativá-lo através do gerenciador de plugins.
Adicionando uma Fonte de Dados REST API
Após ativar o plugin, você pode adicionar uma fonte de dados REST API selecionando-a no menu suspenso "Adicionar novo" na seção de gerenciamento de fontes de dados.
Configure a fonte de dados REST API.
Adicionando uma Coleção
No NocoBase, um recurso RESTful é mapeado para uma coleção, como um recurso de Usuários.
Esses endpoints de API são mapeados no NocoBase da seguinte forma:
Para um guia completo sobre as especificações de design da API do NocoBase, consulte a documentação da API.
Consulte o capítulo "NocoBase API - Core" para informações detalhadas.
A configuração da coleção para uma fonte de dados REST API inclui o seguinte:
Listar
Mapeie a interface para visualizar uma lista de recursos.
Obter
Mapeie a interface para visualizar os detalhes de um recurso.
Criar
Mapeie a interface para criar um recurso.
Atualizar
Mapeie a interface para atualizar um recurso.
Excluir
Mapeie a interface para excluir um recurso.
As interfaces Listar e Obter são de configuração obrigatória.
Depurando a API
Integração de parâmetros de requisição
Exemplo: Configure os parâmetros de paginação para a API Listar. Se a API de terceiros não suportar paginação nativamente, o NocoBase fará a paginação com base nos dados da lista recuperada.
Observe que apenas as variáveis adicionadas na interface terão efeito.
| Nome do parâmetro da API de terceiros | Parâmetro NocoBase |
|---|---|
| page | {{request.params.page}} |
| limit | {{request.params.pageSize}} |
Você pode clicar em "Experimentar" (Try it out) para depurar e visualizar a resposta.
Transformação do formato de resposta
O formato de resposta da API de terceiros pode não estar no padrão NocoBase, e precisa ser transformado antes de ser exibido corretamente no frontend.
Ajuste as regras de conversão com base no formato de resposta da API de terceiros para garantir que a saída esteja em conformidade com o padrão NocoBase.
Descrição do processo de depuração
Variáveis
A fonte de dados REST API oferece três tipos de variáveis para a integração da API:
- Variáveis personalizadas da fonte de dados
- Variáveis de requisição do NocoBase
- Variáveis de resposta de terceiros
Variáveis Personalizadas da Fonte de Dados
Requisição NocoBase
- Params: Parâmetros de consulta da URL (Search Params), que variam dependendo da interface.
- Headers: Cabeçalhos de requisição personalizados, fornecendo principalmente informações X- específicas do NocoBase.
- Body: O corpo da requisição.
- Token: O token da API para a requisição atual do NocoBase.
Respostas de Terceiros
Atualmente, apenas o corpo da resposta está disponível.
Abaixo estão as variáveis disponíveis para cada interface:
Listar
| Parâmetro | Descrição |
|---|---|
| request.params.page | Página atual |
| request.params.pageSize | Número de itens por página |
| request.params.filter | Critérios de filtro (devem seguir o formato de Filtro do NocoBase) |
| request.params.sort | Critérios de ordenação (devem seguir o formato de Ordenação do NocoBase) |
| request.params.appends | Campos a serem carregados sob demanda, geralmente para campos de associação |
| request.params.fields | Campos a serem incluídos (lista de permissões) |
| request.params.except | Campos a serem excluídos (lista de bloqueios) |
Obter
| Parâmetro | Descrição |
|---|---|
| request.params.filterByTk | Obrigatório, geralmente o ID do registro atual |
| request.params.filter | Critérios de filtro (devem seguir o formato de Filtro do NocoBase) |
| request.params.appends | Campos a serem carregados sob demanda, geralmente para campos de associação |
| request.params.fields | Campos a serem incluídos (lista de permissões) |
| request.params.except | Campos a serem excluídos (lista de bloqueios) |
Criar
| Parâmetro | Descrição |
|---|---|
| request.params.whiteList | Lista de permissões |
| request.params.blacklist | Lista de bloqueios |
| request.body | Dados iniciais para criação |
Atualizar
| Parâmetro | Descrição |
|---|---|
| request.params.filterByTk | Obrigatório, geralmente o ID do registro atual |
| request.params.filter | Critérios de filtro (devem seguir o formato de Filtro do NocoBase) |
| request.params.whiteList | Lista de permissões |
| request.params.blacklist | Lista de bloqueios |
| request.body | Dados para atualização |
Excluir
| Parâmetro | Descrição |
|---|---|
| request.params.filterByTk | Obrigatório, geralmente o ID do registro atual |
| request.params.filter | Critérios de filtro (devem seguir o formato de Filtro do NocoBase) |
Configuração de Campos
Os metadados dos campos (Fields) são extraídos dos dados da interface CRUD do recurso adaptado para servir como os campos da coleção.
Extrair metadados dos campos.
Campos e pré-visualização.
Edite os campos (de forma similar a outras fontes de dados).
Adicionando Blocos da Fonte de Dados REST API
Depois que a coleção estiver configurada, você poderá adicionar blocos à interface.
