#REST API Gegevensbron

#Introductie

Met deze plugin kunt u naadloos gegevens van REST API-bronnen integreren.

#Installatie

Dit is een commerciële plugin, wat betekent dat u deze moet uploaden en activeren via de pluginmanager.

#Een REST API-gegevensbron toevoegen

Nadat u de plugin heeft geactiveerd, kunt u een REST API-gegevensbron toevoegen door deze te selecteren uit het 'Nieuwe toevoegen'-dropdownmenu in het gegevensbronbeheer.

Configureer de REST API-gegevensbron.

#Een collectie toevoegen

In NocoBase wordt een RESTful-resource toegewezen aan een collectie, zoals bijvoorbeeld een 'Users' (gebruikers) resource.

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

Deze API-endpoints worden in NocoBase als volgt toegewezen:

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

Voor een uitgebreide handleiding over de NocoBase API-ontwerpspecificaties, verwijzen we u naar de API-documentatie.

Raadpleeg het hoofdstuk "NocoBase API - Core" voor gedetailleerde informatie.

De collectieconfiguratie voor een REST API-gegevensbron omvat het volgende:

#Lijst

Wijs de interface toe voor het bekijken van een lijst met resources.

#Ophalen (Get)

Wijs de interface toe voor het bekijken van resourcedetails.

#Aanmaken (Create)

Wijs de interface toe voor het aanmaken van een resource.

#Bijwerken (Update)

Wijs de interface toe voor het bijwerken van een resource.

#Verwijderen (Destroy)

Wijs de interface toe voor het verwijderen van een resource.

De interfaces voor 'Lijst' en 'Ophalen' moeten beide geconfigureerd zijn.

#De API debuggen

#Integratie van verzoekparameters

Voorbeeld: Configureer pagineringsparameters voor de Lijst-API. Als de externe API zelf geen paginering ondersteunt, zal NocoBase pagineren op basis van de opgehaalde lijstgegevens.

Let op: alleen variabelen die in de interface zijn toegevoegd, worden gebruikt.

U kunt op 'Try it out' klikken om te debuggen en het antwoord te bekijken.

#Transformatie van antwoordformaat

Het antwoordformaat van de externe API voldoet mogelijk niet aan de NocoBase-standaard. Het moet worden getransformeerd voordat het correct op de frontend kan worden weergegeven.

Pas de conversieregels aan op basis van het antwoordformaat van de externe API om ervoor te zorgen dat de uitvoer voldoet aan de NocoBase-standaard.

Beschrijving van het debugproces

#Variabelen

De REST API-gegevensbron ondersteunt drie typen variabelen voor API-integratie:

• Aangepaste gegevensbronvariabelen
• NocoBase-verzoekvariabelen
• Externe antwoordvariabelen

#Aangepaste gegevensbronvariabelen

#NocoBase-verzoek

• Params: URL-queryparameters (Search Params), die per interface kunnen verschillen.
• Headers: Aangepaste verzoekheaders, die voornamelijk specifieke X-informatie van NocoBase bevatten.
• Body: De verzoekbody.
• Token: De API-token voor het huidige NocoBase-verzoek.

#Externe antwoorden

Momenteel is alleen de antwoordbody beschikbaar.

Hieronder vindt u de variabelen die beschikbaar zijn voor elke interface:

#Lijst

#Ophalen (Get)

#Aanmaken (Create)

#Bijwerken (Update)

#Verwijderen (Destroy)

#Veldconfiguratie

Veldmetadata (Fields) worden geëxtraheerd uit de CRUD-interfacedata van de aangepaste resource om te dienen als de velden van de collectie.

Extraheer veldmetadata.

Velden en preview.

Bewerk velden (vergelijkbaar met andere gegevensbronnen).

#REST API-gegevensbronblokken toevoegen

Zodra de collectie is geconfigureerd, kunt u blokken toevoegen aan de interface.