Informacje ogólne

Ostatni moduł zakończył się stworzeniem pierwszego procesu biznesowego. Zorientowaliśmy się, jak tworzyć logikę procesu, przyjmować określone parametry wejściowe, wykonywać obliczenia i wystawiać odpowiedź. Pozostaje odpowiedzieć na główne pytanie. Jak aktywować stworzony proces biznesowy i uruchomić go?

Do rozwiązania tego problemu przeznaczone są punkty końcowe - kluczowe punkty interakcji z aplikacją. W pierwszych modułach mieliśmy już interakcję z zewnętrznymi API. Było to możliwe dzięki obecności endpointów. Były one opisane w dokumentacji, a my czytając ją zrozumieliśmy, jaką metodą i jakim adresem URL należy wysłać żądanie dostępu do określonego zasobu.

Dla zrozumienia przyjrzyjmy się implementacji endpointów na konkretnym przykładzie. W trzecim module został utworzony model bazy danych. Równocześnie z tworzeniem tabel automatycznie zostały utworzone punkty końcowe umożliwiające interakcję z nimi. Przejdźmy do sekcji endpoints (na lewym panelu) i przyjrzyjmy się im.

Na przykładzie tabeli "city" z informacjami o miastach widać, że posiada ona już 6 endpointów do podstawowych operacji na danych.

• GET /city - pobieranie wszystkich danych z tabeli
• GET /city/:id - pobieranie danych o mieście o podanym id
• POST /city - dodanie nowego rekordu do tabeli
• PUT /city/:id - całkowite zastąpienie rekordu o podanym id w tabeli
• PATCH /city/:id - częściowe zastąpienie rekordu o podanym id w tabeli
• DELETE /city/:id - usunięcie z tabeli rekordu o podanym id

Ustawienia ogólne

Możesz otworzyć ustawienia dla każdego punktu końcowego i zbadać je bardziej szczegółowo. Na przykład, rozważ punkt końcowy GET /city/:id

Obraz, który widzimy, jest bardzo podobny do tego, co widzieliśmy już podczas tworzenia żądania do zewnętrznych interfejsów API. W jednym przypadku jedynie uzyskaliśmy dostęp do gotowego endpointu, a teraz sami tworzymy i konfigurujemy ten endpoint. Aby skonfigurować, należy określić:

1. Metoda żądania. W tym przykładzie jest to metoda GET.
2. Request URL. Pierwsza część ze ścieżką do serwera nie jest określona. Jest ona taka sama dla wszystkich punktów końcowych aplikacji. Wystarczy określić tylko końcówkę (/city). W tym miejscu określany jest również parametr URL. Endpoint jest przeznaczony do odbierania informacji o konkretnym mieście, więc jego id zapisane po ":" jest przekazywane jako parametr.
3. Endpoint Groups. Parametr ten nie wpływa w żaden sposób na działanie endpointa i jest przeznaczony jedynie dla wygody organizacji. Wszystkie punkty końcowe mogą być podzielone na grupy tematyczne (foldery). W tym przykładzie grupa "city" zawiera wszystkie punkty końcowe do pracy z danymi o miastach.
4. Business Process. Jest to najważniejszy element konfiguracji i jest to coś, co nie mogło być w żaden sposób widoczne podczas wysyłania żądania do punktu końcowego. Wskazanie procesu biznesowego określa, co ten endpoint będzie robił. Jednocześnie sam endpoint może pozostać niezmieniony, będzie odbierał wszystkie te same żądania pod starym adresem, a jednocześnie w przypadku wymiany procesu biznesowego będzie pełnił zupełnie inną funkcję. Procesy biznesowe dla podstawowych czynności w bazie danych są tworzone automatycznie. Nazywa się je systemowymi procesami biznesowymi. Takie BP nie mogą być zmieniane, ale mogą być w każdej chwili zastąpione BP tworzonymi niezależnie, niestandardowymi procesami biznesowymi.
5. Input/Output variables. Utworzony proces biznesowy wykorzystuje różne zmienne wejściowe i wyjściowe, ale punkt końcowy nie musi korzystać z nich wszystkich. Część może być wyłączona lub skonfigurowana tak, że różne punkty końcowe uzyskują dostęp do tego samego BP, z indywidualnym zestawem zmiennych. Konfiguruje się tam również typ żądania i odpowiedzi (Request / Response type). Najczęściej typem tym będzie JSON, ale w razie potrzeby można użyć innych opcji, takich jak XML lub Render File (ten typ odpowiedzi jest używany w endpointach do pracy z plikami).

Ustawienia Middleware

Do utworzenia i dalszego korzystania z endpointu wystarczą ustawienia ogólne, ale w razie potrzeby można użyć dodatkowych parametrów. Najważniejszym z nich jest aktywacja Middleware za pomocą tokena Auth.

Jego użycie pozwala na odmówienie dostępu do tego punktu końcowego użytkownikom, którzy nie zostali autoryzowani lub nie należą do określonej grupy (na przykład dostęp można przyznać tylko administratorom i odmówić go innym użytkownikom).

Ustawienia logowania i wyjścia

Ponadto można użyć ustawień na karcie Settings, aby dodatkowo logować nagłówki lub ciało żądania, a także ukryć z odpowiedzi te pola, których wartości nie są ustawione.