#pkg: "@nocobase/plugin-data-source-rest-api"

#Źródło danych REST API

#Wprowadzenie

Ten plugin pozwala na integrację danych pochodzących ze źródeł REST API.

#Instalacja

Ta wtyczka jest komercyjna, dlatego wymaga przesłania i aktywacji za pośrednictwem menedżera wtyczek.

#Dodawanie źródła danych REST API

Po aktywacji wtyczki mogą Państwo dodać źródło danych REST API, wybierając je z rozwijanego menu „Add new” w sekcji zarządzania źródłami danych.

Proszę skonfigurować źródło danych REST API.

#Dodawanie kolekcji

W NocoBase zasób RESTful jest mapowany na kolekcję, na przykład zasób Użytkownicy.

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

Te punkty końcowe API są mapowane w NocoBase w następujący sposób:

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

Aby uzyskać kompleksowy przewodnik po specyfikacjach projektowania API NocoBase, proszę zapoznać się z dokumentacją API.

Szczegółowe informacje znajdą Państwo w rozdziale „NocoBase API - Core”.

Konfiguracja kolekcji dla źródła danych REST API obejmuje następujące elementy:

#Lista

Proszę zmapować interfejs do przeglądania listy zasobów.

#Pobierz

Proszę zmapować interfejs do przeglądania szczegółów zasobu.

#Utwórz

Proszę zmapować interfejs do tworzenia zasobu.

#Zaktualizuj

Proszę zmapować interfejs do aktualizacji zasobu.

#Usuń

Proszę zmapować interfejs do usuwania zasobu.

Interfejsy Lista i Pobierz są obowiązkowe do skonfigurowania.

#Debugowanie API

#Integracja parametrów żądania

Przykład: Proszę skonfigurować parametry stronicowania dla interfejsu API Listy. Jeśli zewnętrzne API nie obsługuje stronicowania natywnie, NocoBase będzie stronicować na podstawie pobranych danych listy.

Proszę pamiętać, że tylko zmienne dodane w interfejsie będą aktywne.

Mogą Państwo kliknąć „Try it out”, aby debugować i wyświetlić odpowiedź.

#Transformacja formatu odpowiedzi

Format odpowiedzi zewnętrznego API może nie być zgodny ze standardem NocoBase, dlatego wymaga transformacji, aby mógł być poprawnie wyświetlony w interfejsie użytkownika.

Proszę dostosować reguły konwersji na podstawie formatu odpowiedzi zewnętrznego API, aby upewnić się, że wynik jest zgodny ze standardem wyjściowym NocoBase.

Opis procesu debugowania

#Zmienne

Źródło danych REST API udostępnia trzy typy zmiennych do integracji z interfejsami API:

• Niestandardowe zmienne źródła danych
• Zmienne żądania NocoBase
• Zmienne odpowiedzi zewnętrznych API

#Niestandardowe zmienne źródła danych

#Żądanie NocoBase

• Params: Parametry zapytania URL (Search Params), które różnią się w zależności od interfejsu;
• Headers: Niestandardowe nagłówki żądania, głównie dostarczające specyficzne informacje X- od NocoBase;
• Body: Treść żądania;
• Token: Token API dla bieżącego żądania NocoBase.

#Odpowiedzi zewnętrznych API

Obecnie dostępna jest tylko treść odpowiedzi.

Poniżej przedstawiono zmienne dostępne dla każdego interfejsu:

#Lista

#Pobierz

#Utwórz

#Zaktualizuj

#Usuń

#Konfiguracja pól

Metadane pól (Fields) są wyodrębniane z danych interfejsu CRUD dostosowanego zasobu i służą jako pola kolekcji.

Wyodrębnianie metadanych pól.

Pola i podgląd.

Edycja pól (podobnie jak w przypadku innych źródeł danych).

#Dodawanie bloków źródła danych REST API

Po skonfigurowaniu kolekcji mogą Państwo dodać bloki do interfejsu.