#REST API Datenquelle

#Einführung

Dieses Plugin ermöglicht Ihnen die nahtlose Integration von Daten aus REST API Quellen.

#Installation

Dieses Plugin ist ein kommerzielles Plugin und muss über den Plugin-Manager hochgeladen und aktiviert werden.

#Hinzufügen einer REST API Datenquelle

Nach der Aktivierung des Plugins können Sie eine REST API Datenquelle hinzufügen, indem Sie diese im Dropdown-Menü „Neu hinzufügen“ der Datenquellenverwaltung auswählen.

Konfigurieren Sie die REST API Datenquelle.

#Hinzufügen einer Sammlung

In NocoBase wird eine RESTful-Ressource einer Sammlung zugeordnet, zum Beispiel eine Benutzer-Ressource.

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

Diese API-Endpunkte werden in NocoBase wie folgt zugeordnet:

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

Eine umfassende Anleitung zu den NocoBase API-Designspezifikationen finden Sie in der API-Dokumentation.

Lesen Sie das Kapitel „NocoBase API – Core“ für detaillierte Informationen.

Die Sammlungskonfiguration für eine REST API Datenquelle umfasst Folgendes:

#List

Konfigurieren Sie die Schnittstellen-Zuordnung für die Anzeige einer Ressourcenliste.

#Get

Konfigurieren Sie die Schnittstellen-Zuordnung für die Anzeige von Ressourcendetails.

#Create

Konfigurieren Sie die Schnittstellen-Zuordnung für die Erstellung einer Ressource.

#Update

Konfigurieren Sie die Schnittstellen-Zuordnung für die Aktualisierung einer Ressource.

#Destroy

Konfigurieren Sie die Schnittstellen-Zuordnung für das Löschen einer Ressource.

Die Schnittstellen „List“ und „Get“ müssen beide konfiguriert werden.

#Debugging der API

#Integration von Anfrageparametern

Beispiel: Konfigurieren Sie Paginierungsparameter für die List-API. Falls die Drittanbieter-API selbst keine Paginierung unterstützt, paginiert NocoBase basierend auf den abgerufenen Listendaten.

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

Sie können auf „Try it out“ klicken, um die Debugging-Funktion zu nutzen und die Antwort anzuzeigen.

#Transformation des Antwortformats

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

Passen Sie die Konvertierungsregeln basierend auf dem Antwortformat der Drittanbieter-API an, um sicherzustellen, dass die Ausgabe dem NocoBase-Standard entspricht.

Beschreibung des Debugging-Prozesses

#Variablen

Die REST API Datenquelle unterstützt drei Arten von Variablen für die API-Integration:

• Benutzerdefinierte Datenquellenvariablen
• NocoBase-Anfragevariablen
• Drittanbieter-Antwortvariablen

#Benutzerdefinierte Datenquellenvariablen

#NocoBase-Anfrage

• Params: URL-Abfrageparameter (Search Params), die je nach Schnittstelle variieren.
• Headers: Benutzerdefinierte Anfrage-Header, die hauptsächlich spezifische X-Informationen von NocoBase bereitstellen.
• Body: Der Anfragetext (Body).
• Token: Der API-Token für die aktuelle NocoBase-Anfrage.

#Drittanbieter-Antworten

Derzeit ist nur der Antworttext (Body) verfügbar.

Die für jede Schnittstelle verfügbaren Variablen sind unten aufgeführt:

#List

#Get

#Create

#Update

#Destroy

#Feldkonfiguration

Feldmetadaten (Felder) werden aus den CRUD-Schnittstellendaten der angepassten Ressource extrahiert, um als Felder der Sammlung zu dienen.

Extrahieren Sie Feldmetadaten.

Felder und Vorschau.

Felder bearbeiten (ähnlich wie bei anderen Datenquellen).

#Hinzufügen von REST API Datenquellen-Blöcken

Sobald die Sammlung konfiguriert ist, können Sie Blöcke zur Oberfläche hinzufügen.