#Fuente de datos REST API

#Introducción

Se utiliza para conectar datos provenientes de una REST API.

#Instalación

Este plugin es comercial. Para conocer los detalles de activación, consulta: Guía de activación de plugins comerciales

#Añadir una fuente REST API

Después de activar el plugin, selecciona REST API en el menú desplegable Add new de la gestión de fuentes de datos.

Configurar la fuente REST API

#Añadir una Collection

Los recursos RESTful son las Collections de NocoBase; por ejemplo, el recurso Users.

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

La configuración correspondiente en la API de NocoBase es:

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

Para consultar la especificación completa de diseño de la API de NocoBase, consulta la documentación de la API.

Consulta la sección «NocoBase API - Core».

La configuración de la Collection de la fuente de datos REST API es la siguiente:

#List

Configura la asignación de la interfaz para consultar la lista de recursos.

#Get

Configura la asignación de la interfaz para consultar los detalles de un recurso.

#Create

Configura la asignación de la interfaz para crear un recurso.

#Update

Configura la asignación de la interfaz para actualizar un recurso.

#Destroy

Configura la asignación de la interfaz para eliminar un recurso.

Las interfaces List y Get son obligatorias.

#Depurar la API

#Conectar los parámetros de la solicitud

Ejemplo: configura los parámetros de paginación para la interfaz List (si la API de terceros no admite la paginación, los datos de la lista obtenidos se paginarán).

Ten en cuenta que solo tendrán efecto las variables que se hayan añadido en la interfaz.

Puedes hacer clic en Try it out para depurar y consultar el resultado de la respuesta.

#Conversión del formato de respuesta

El formato de respuesta de una API de terceros puede no coincidir con el estándar de NocoBase; es necesario convertirlo para que se muestre correctamente en el frontend.

Ajusta las reglas de conversión según el formato de respuesta de la API de terceros para adaptarlo al estándar de salida de NocoBase.

Descripción del proceso de depuración

#Conversión de la información de error

Cuando se produce un error en la API de terceros, el formato de la información de error de la respuesta puede no coincidir con el estándar de NocoBase; es necesario convertirlo para que se muestre correctamente en el frontend.

Si no se configura la conversión de la información de error, de forma predeterminada se convertirá en un mensaje de error que incluye el código de estado HTTP.

Después de configurar la conversión de la información de error, esta se adapta al estándar de salida de NocoBase y el frontend puede mostrar correctamente la información de error de la API de terceros.

#Variables

La fuente de datos REST API proporciona tres tipos de variables para conectar las interfaces:

• Variables personalizadas de la fuente de datos
• Solicitud de NocoBase
• Respuesta de terceros

#Variables personalizadas de la fuente de datos

#Solicitud de NocoBase

• Params: parámetros de consulta de la URL (Search Params); los Params pueden variar según la interfaz.
• Headers: cuerpo de la solicitud; proporciona principalmente algunos encabezados X- personalizados de NocoBase.
• Body: cuerpo de la solicitud.
• Token: token de API de la solicitud actual de NocoBase.

#Respuesta de terceros

Actualmente, solo se proporciona el Body de la respuesta.

Las variables disponibles al conectar cada interfaz son las siguientes:

#List

#Get

#Create

#Update

#Destroy

#Configurar campos

Extrae los metadatos de los campos (Fields) de los datos de las interfaces CRUD del recurso adaptado para utilizarlos como campos de la Collection.

Extraer los metadatos de los campos.

Campos y vista previa.

Editar campos (de forma similar a otras fuentes de datos).

#Añadir un bloque de fuente de datos REST API

Una vez configurada la Collection, puedes añadir bloques desde la interfaz.