Modelowanie żądań API
Aby stworzyć proste GET żądanie poprzez zewnętrzny interfejs API, należy wybrać sekcję Business Logic i kliknąć Create API request przycisk w External API Requests w zakładce. W nowym oknie modalnym należy wprowadzić nazwę i opis procesu biznesowego (opcjonalnie).
Następnie należy wybrać method żądania, które chcesz wykonać, endpoint adres i wypełnij wymagane parametry żądania (query params w przykładzie poniżej). W niektórych przypadkach konieczne jest wypełnienie. header, body oraz url params, w zależności od zadania, jakie stoi przed użytkownikiem.
W BP można również przetestować proces, klikając Test request przycisk . W wyświetlonym oknie wpisz parametry żądania i kliknij na Execute request przycisk. W zakładce body zostanie wyświetlona treść odpowiedzi, jeżeli żądanie zostanie wykonane pomyślnie. Autofill Response Funkcja parsuje odpowiedź i pomaga stworzyć niezbędne modele. Po kliknięciu na Autofill Response zostanie automatycznie wygenerowany szablon odpowiedzi dla tego punktu końcowego do dalszego wykorzystania.
Możliwe jest stworzenie modelu danych znającego pola odpowiedzi. Aby to zrobić, należy przejść do Data Design i stworzyć nowy model wypełniając go zgodnie z danymi, które mają być zapisane do bazy danych.
Używanie żądań API w backendzie
Następnie należy otworzyć Business Logic sekcję i kliknąć Create business project aby utworzyć model BP do odbierania danych przez zewnętrzne API i zapisywania ich do określonej Data Model. W odpowiednich blokach należy odnaleźć blok nowo utworzonego procesu API.
Do wykonania żądania należy przekazać odpowiednie parametry skonfigurowane wcześniej w edytorze żądania zewnętrznego API (Query Params w poniższym przykładzie). Użyj . Make - Expand kombinacji bloków do przetwarzania i tworzenia danych poprzez BP. Przykład tworzenia i przekazywania parametrów pokazany jest na poniższym zrzucie ekranu.
Następnie output body musi zostać rozwinięty i zapisany w data model. W poniższym przykładzie otrzymujemy cenę bitcoina w stosunku do dolarów (USD).
W celu zapisania danych odpowiedzi do . DB, Make oraz DB: Create używane są bloki typu .
Następnie należy utworzyć blok Endpoint dla nowo utworzonego BP aby mieć do niego dostęp z poziomu frontendu aplikacji internetowej.
Używanie żądań API we frontendzie
Z poziomu frontendu aplikacji należy użyć Server request GET dla określonego punktu końcowego, jak na poniższym zrzucie ekranu.