#Zdroj dat REST API

#Úvod

Tento plugin Vám umožňuje bezproblémovou integraci dat ze zdrojů REST API.

#Instalace

Jelikož se jedná o komerční plugin, je nutné jej nahrát a aktivovat prostřednictvím správce pluginů.

#Přidání zdroje REST API

Po aktivaci pluginu můžete přidat zdroj REST API tak, že jej vyberete z rozbalovací nabídky „Přidat nový“ v sekci správy zdrojů dat.

Nakonfigurujte zdroj REST API.

#Přidání kolekce

V NocoBase je RESTful zdroj mapován na kolekci, například zdroj Users.

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

Tyto API endpointy jsou v NocoBase mapovány následovně:

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

Komplexního průvodce specifikacemi návrhu NocoBase API naleznete v dokumentaci API.

Podrobné informace naleznete v kapitole „NocoBase API – Core“.

Konfigurace kolekce pro zdroj dat REST API zahrnuje následující:

#List

Namapujte rozhraní pro zobrazení seznamu zdrojů.

#Get

Namapujte rozhraní pro zobrazení detailů zdroje.

#Create

Namapujte rozhraní pro vytvoření zdroje.

#Update

Namapujte rozhraní pro aktualizaci zdroje.

#Destroy

Namapujte rozhraní pro smazání zdroje.

Rozhraní List a Get je nutné nakonfigurovat.

#Ladění API

#Integrace parametrů požadavku

Příklad: Nakonfigurujte parametry stránkování pro API List. Pokud API třetí strany nativně nepodporuje stránkování, NocoBase provede stránkování na základě načtených dat seznamu.

Vezměte prosím na vědomí, že účinné budou pouze proměnné přidané v rozhraní.

Můžete kliknout na „Vyzkoušet“ (Try it out) pro ladění a zobrazení odpovědi.

#Transformace formátu odpovědi

Formát odpovědi API třetí strany nemusí odpovídat standardu NocoBase a je třeba jej transformovat, aby se správně zobrazil na front-endu.

Upravte pravidla konverze na základě formátu odpovědi API třetí strany, abyste zajistili, že výstup bude odpovídat standardu NocoBase.

Popis procesu ladění

#Proměnné

Zdroj dat REST API podporuje tři typy proměnných pro integraci API:

• Vlastní proměnné zdroje dat
• Proměnné požadavku NocoBase
• Proměnné odpovědi třetí strany

#Vlastní proměnné zdroje dat

#Požadavek NocoBase

• Params: Parametry dotazu URL (Search Params), které se liší v závislosti na rozhraní.
• Headers: Vlastní hlavičky požadavku, primárně poskytující specifické X- informace z NocoBase.
• Body: Tělo požadavku.
• Token: API token pro aktuální požadavek NocoBase.

#Odpovědi třetích stran

V současné době je k dispozici pouze tělo odpovědi.

Níže jsou uvedeny proměnné dostupné pro každé rozhraní:

#List

#Get

#Create

#Update

#Destroy

#Konfigurace polí

Metadata polí (Fields) jsou extrahována z dat rozhraní CRUD adaptovaného zdroje a slouží jako pole kolekce.

Extrahujte metadata polí.

Pole a náhled.

Upravte pole (podobně jako u jiných zdrojů dat).

#Přidání bloků zdroje dat REST API

Jakmile je kolekce nakonfigurována, můžete do rozhraní přidat bloky.