#REST-API-Datenquelle

#Einführung

Dient zum Anbinden von Daten aus REST-API-Quellen.

#Installation

Dieses Plugin ist ein kommerzielles Plugin. Eine detaillierte Anleitung zur Aktivierung finden Sie unter Anleitung zur Aktivierung kommerzieller Plugins.

#REST-API-Quelle hinzufügen

Wählen Sie nach der Aktivierung des Plugins im Dropdown-Menü „Add new“ der Datenquellenverwaltung die Option „REST API“ aus.

REST-API-Quelle konfigurieren

#Collection hinzufügen

RESTful-Ressourcen entsprechen den Collections in NocoBase, zum Beispiel der Ressource „Users“.

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

Die entsprechende Konfiguration in der NocoBase-API lautet:

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

Die vollständige Spezifikation des NocoBase-API-Designs finden Sie in der API-Dokumentation.

Siehe den Abschnitt „NocoBase API - Core“.

Die Collection-Konfiguration der REST-API-Datenquelle sieht wie folgt aus:

#List

Konfigurieren Sie die Schnittstellenzuordnung zum Abrufen der Ressourcenliste.

#Get

Konfigurieren Sie die Schnittstellenzuordnung zum Abrufen der Ressourcendetails.

#Create

Konfigurieren Sie die Schnittstellenzuordnung zum Erstellen einer Ressource.

#Update

Konfigurieren Sie die Schnittstellenzuordnung zum Aktualisieren einer Ressource.

#Destroy

Konfigurieren Sie die Schnittstellenzuordnung zum Löschen einer Ressource.

Die Schnittstellen List und Get müssen konfiguriert werden.

#API debuggen

#Anforderungsparameter anbinden

Beispiel: Konfigurieren Sie für die List-Schnittstelle die Parameter für die Seitennavigation. (Wenn die Drittanbieter-API selbst keine Seitennavigation unterstützt, werden die abgerufenen Listendaten für die Seitennavigation verwendet.)

Beachten Sie, dass nur Variablen wirksam werden, die bereits in der Schnittstelle hinzugefügt wurden.

Klicken Sie auf „Try it out“, um den Vorgang zu testen und das Antwortergebnis anzuzeigen.

#Antwortformat konvertieren

Das Antwortformat der Drittanbieter-API entspricht möglicherweise nicht dem NocoBase-Standard und muss konvertiert werden, damit es im Frontend korrekt angezeigt werden kann.

Passen Sie die Konvertierungsregeln entsprechend dem Antwortformat der Drittanbieter-API an, sodass sie dem NocoBase-Ausgabestandard entsprechen.

Beschreibung des Debugging-Ablaufs

#Fehlerinformationen konvertieren

Wenn bei der Drittanbieter-API ein Fehler auftritt, entspricht das Format der Fehlerinformationen in der Antwort möglicherweise nicht dem NocoBase-Standard und muss konvertiert werden, damit es im Frontend korrekt angezeigt werden kann.

Wenn keine Konvertierung der Fehlerinformationen konfiguriert ist, werden diese standardmäßig in eine Fehlerinformation mit HTTP-Statuscode konvertiert.

Nach der Konfiguration der Konvertierung der Fehlerinformationen entsprechen diese dem NocoBase-Ausgabestandard, sodass das Frontend die Fehlerinformationen der Drittanbieter-API korrekt anzeigen kann.

#Variablen

Die REST-API-Datenquelle stellt drei Arten von Variablen für die Anbindung von Schnittstellen bereit:

• Benutzerdefinierte Variablen der Datenquelle
• NocoBase-Anfrage
• Antwort der Drittanbieter-API

#Benutzerdefinierte Variablen der Datenquelle

#NocoBase-Anfrage

• Params: URL-Abfrageparameter (Search Params); die Params unterscheiden sich je nach Schnittstelle.
• Headers: Anforderungskopf, der hauptsächlich einige benutzerdefinierte X-Informationen von NocoBase bereitstellt.
• Body: Body der Anfrage.
• Token: API-Token der aktuellen NocoBase-Anfrage.

#Antwort der Drittanbieter-API

Derzeit wird nur der Body der Antwort bereitgestellt.

Bei der Anbindung der einzelnen Schnittstellen stehen die folgenden Variablen zur Verfügung:

#List

#Get

#Create

#Update

#Destroy

#Felder konfigurieren

Extrahieren Sie aus den Daten der CRUD-Schnittstellen der angebundenen Ressource die Metadaten der Felder (Fields) und verwenden Sie sie als Felder der Collection.

Feldmetadaten extrahieren.

Felder und Vorschau.

Felder bearbeiten (ähnlich wie bei anderen Datenquellen).

#Block für die REST-API-Datenquelle hinzufügen

Nachdem die Collection konfiguriert wurde, können Sie in der Benutzeroberfläche einen Block hinzufügen.