Detta dokument har översatts av AI. För eventuella felaktigheter, se den engelska versionen
REST API datakälla
This feature is provided by the commercial plugin «Datakälla: REST API», please purchase to useIntroduktion
Denna plugin låter dig smidigt integrera data från REST API-källor.
Installation
Eftersom detta är en kommersiell plugin behöver ni ladda upp och aktivera den via pluginhanteraren.
Lägga till en REST API-datakälla
Efter att ni har aktiverat pluginen kan ni lägga till en REST API-datakälla genom att välja den från rullgardinsmenyn "Lägg till ny" i avsnittet för datakällshantering.
Konfigurera REST API-datakällan.
Lägga till en samling
I NocoBase mappas en RESTful-resurs till en samling, till exempel en Users-resurs.
Dessa API-slutpunkter mappas i NocoBase på följande sätt:
För en omfattande guide om NocoBase API-designspecifikationer, se API-dokumentationen.
Se kapitlet "NocoBase API - Core" för detaljerad information.
Konfigurationen för en samling i en REST API-datakälla inkluderar följande:
Lista
Mappa gränssnittet för att visa en lista över resurser.
Hämta
Mappa gränssnittet för att visa resursdetaljer.
Skapa
Mappa gränssnittet för att skapa en resurs.
Uppdatera
Mappa gränssnittet för att uppdatera en resurs.
Radera
Mappa gränssnittet för att radera en resurs.
Både gränssnitten för "Lista" och "Hämta" måste konfigureras.
Felsöka API:et
Integrering av förfrågningsparametrar
Exempel: Konfigurera sidnumreringsparametrar för List-API:et. Om tredjeparts-API:et inte stöder sidnumrering inbyggt, kommer NocoBase att sidnumrera baserat på den hämtade listdatan.
Observera att endast variabler som har lagts till i gränssnittet kommer att gälla.
| Tredjeparts-API-parameternamn | NocoBase-parameter |
|---|---|
| page | {{request.params.page}} |
| limit | {{request.params.pageSize}} |
Ni kan klicka på "Try it out" för att felsöka och se svaret.
Omvandling av svarsformat
Svarsformatet från tredjeparts-API:et kanske inte följer NocoBase-standarden, och det behöver omvandlas innan det kan visas korrekt i frontend.
Justera omvandlingsreglerna baserat på tredjeparts-API:ets svarsformat för att säkerställa att utdata överensstämmer med NocoBase-standarden.
Beskrivning av felsökningsprocessen
Variabler
REST API-datakällan stöder tre typer av variabler för API-integrering:
- Anpassade datakällsvariabler
- NocoBase förfrågningsvariabler
- Tredjepartssvarsvariabler
Anpassade datakällsvariabler
NocoBase-förfrågan
- Params: URL-frågeparametrar (Search Params), som varierar beroende på gränssnittet.
- Headers: Anpassade förfrågningshuvuden, som primärt tillhandahåller specifik X-information från NocoBase.
- Body: Förfrågans brödtext.
- Token: API-token för den aktuella NocoBase-förfrågan.
Tredjepartssvar
För närvarande är endast svarsbrödtexten tillgänglig.
Nedan följer de variabler som är tillgängliga för varje gränssnitt:
Lista
| Parameter | Beskrivning |
|---|---|
| request.params.page | Aktuell sida |
| request.params.pageSize | Antal objekt per sida |
| request.params.filter | Filterkriterier (måste uppfylla NocoBase Filter-format) |
| request.params.sort | Sorteringskriterier (måste uppfylla NocoBase Sort-format) |
| request.params.appends | Fält att ladda vid behov, vanligtvis för relationsfält |
| request.params.fields | Fält att inkludera (vitlista) |
| request.params.except | Fält att exkludera (svartlista) |
Hämta
| Parameter | Beskrivning |
|---|---|
| request.params.filterByTk | Obligatoriskt, vanligtvis det aktuella post-ID:t |
| request.params.filter | Filterkriterier (måste uppfylla NocoBase Filter-format) |
| request.params.appends | Fält att ladda vid behov, vanligtvis för relationsfält |
| request.params.fields | Fält att inkludera (vitlista) |
| request.params.except | Fält att exkludera (svartlista) |
Skapa
| Parameter | Beskrivning |
|---|---|
| request.params.whiteList | Vitlista |
| request.params.blacklist | Svartlista |
| request.body | Initial data för skapande |
Uppdatera
| Parameter | Beskrivning |
|---|---|
| request.params.filterByTk | Obligatoriskt, vanligtvis det aktuella post-ID:t |
| request.params.filter | Filterkriterier (måste uppfylla NocoBase Filter-format) |
| request.params.whiteList | Vitlista |
| request.params.blacklist | Svartlista |
| request.body | Data för uppdatering |
Radera
| Parameter | Beskrivning |
|---|---|
| request.params.filterByTk | Obligatoriskt, vanligtvis det aktuella post-ID:t |
| request.params.filter | Filterkriterier (måste uppfylla NocoBase Filter-format) |
Fältkonfiguration
Fältmetadata (Fields) extraheras från CRUD-gränssnittsdatan för den anpassade resursen för att fungera som fält för samlingen.
Extrahera fältmetadata.
Fält och förhandsgranskning.
Redigera fält (liknande hur ni gör med andra datakällor).
Lägga till REST API-datakällsblock
När samlingen är konfigurerad kan ni lägga till block i gränssnittet.
