#Fonte Dati API REST

#Introduzione

Questo plugin Le permette di integrare facilmente dati provenienti da fonti API REST.

#Installazione

Trattandosi di un plugin commerciale, è necessario caricarlo e attivarlo tramite il gestore dei plugin.

#Aggiungere una Fonte Dati API REST

Dopo aver attivato il plugin, può aggiungere una fonte dati API REST selezionandola dal menu a tendina Add new nella sezione di gestione delle fonti dati.

Configuri la fonte dati API REST.

#Aggiungere una Collezione

In NocoBase, una risorsa RESTful viene mappata a una collezione, come ad esempio una risorsa Users.

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

Questi endpoint API sono mappati in NocoBase come segue:

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

Per una guida completa sulle specifiche di progettazione delle API di NocoBase, consulti la documentazione API.

Consulti il capitolo "NocoBase API - Core" per informazioni dettagliate.

La configurazione della collezione per una fonte dati API REST include quanto segue:

#List

Mappi l'interfaccia per visualizzare un elenco di risorse.

#Get

Mappi l'interfaccia per visualizzare i dettagli di una risorsa.

#Create

Mappi l'interfaccia per creare una risorsa.

#Update

Mappi l'interfaccia per aggiornare una risorsa.

#Destroy

Mappi l'interfaccia per eliminare una risorsa.

Le interfacce List e Get sono entrambe obbligatorie e devono essere configurate.

#Debugging delle API

#Integrazione dei parametri di richiesta

Esempio: Configuri i parametri di paginazione per l'API List. Se l'API di terze parti non supporta nativamente la paginazione, NocoBase la gestirà basandosi sui dati dell'elenco recuperato.

Tenga presente che solo le variabili aggiunte nell'interfaccia avranno effetto.

Può cliccare su Try it out per eseguire il debugging e visualizzare la risposta.

#Trasformazione del formato di risposta

Il formato di risposta dell'API di terze parti potrebbe non essere conforme allo standard NocoBase e deve essere trasformato prima di poter essere visualizzato correttamente sul frontend.

Regoli le regole di conversione in base al formato di risposta dell'API di terze parti per assicurarsi che l'output sia conforme allo standard NocoBase.

Descrizione del processo di debugging

#Variabili

La fonte dati API REST supporta tre tipi di variabili per l'integrazione delle API:

• Variabili personalizzate della fonte dati
• Variabili di richiesta NocoBase
• Variabili di risposta di terze parti

#Variabili personalizzate della Fonte Dati

#Richiesta NocoBase

• Params: parametri di query URL (Search Params), che variano a seconda dell'interfaccia.
• Headers: intestazioni di richiesta personalizzate, che forniscono principalmente informazioni X- specifiche di NocoBase.
• Body: il corpo della richiesta.
• Token: il token API per la richiesta NocoBase corrente.

#Risposte di Terze Parti

Attualmente, è disponibile solo il corpo della risposta.

Di seguito sono riportate le variabili disponibili per ciascuna interfaccia:

#List

#Get

#Create

#Update

#Destroy

#Configurazione dei Campi

I metadati dei campi (Fields) vengono estratti dai dati dell'interfaccia CRUD della risorsa adattata per fungere da campi della collezione.

Estrazione dei metadati dei campi.

Campi e anteprima.

Modifica dei campi (simile ad altre fonti dati).

#Aggiungere Blocchi della Fonte Dati API REST

Una volta configurata la collezione, può aggiungere blocchi all'interfaccia.