Algemene informatie

De laatste module eindigde met de creatie van het eerste bedrijfsproces. We hebben ontdekt hoe we proceslogica kunnen creëren, specifieke invoerparameters kunnen accepteren, berekeningen kunnen uitvoeren en een antwoord kunnen geven. Rest ons nog de belangrijkste vraag te beantwoorden. Hoe het gecreëerde bedrijfsproces te activeren en in werking te stellen?

Om dit probleem op te lossen zijn eindpunten bedoeld - belangrijke punten van interactie met de applicatie. In de eerste modules hebben we al interactie met externe API's gehad. Dit was mogelijk dankzij de aanwezigheid van endpoints. Ze werden beschreven in de documentatie, en we hebben ze gelezen en begrepen welke methode en welke URL nodig zijn om een verzoek te sturen voor toegang tot een specifieke bron.

Laten we voor een goed begrip de implementatie van endpoints bekijken aan de hand van een specifiek voorbeeld. In de derde module is het databasemodel gemaakt. Tegelijkertijd met het aanmaken van de tabellen werden automatisch endpoints aangemaakt om ermee te interageren. Laten we naar de sectie eindpunten gaan (in het linkerpaneel) en ze bekijken.

In het voorbeeld van de tabel "city" met informatie over steden is te zien dat deze al 6 eindpunten heeft voor basisgegevensbewerkingen.

• GET /city - alle gegevens uit een tabel halen
• GET /city/:id - gegevens ophalen over de stad met het opgegeven id
• POST /city - een nieuw record aan de tabel toevoegen
• PUT /city/:id - volledige vervanging van het record met het opgegeven id in de tabel
• PATCH /city/:id - gedeeltelijke vervanging van een record met de opgegeven id in de tabel
• DELETE /city/:id - verwijderen van een record met het gespecificeerde id uit de tabel

Algemene instellingen

U kunt de instellingen voor elk eindpunt openen en deze nader bestuderen. Neem bijvoorbeeld het eindpunt GET /city/:id

Het beeld dat we zien lijkt sterk op wat we al hebben gezien toen we een verzoek naar externe API's maakten. In het ene geval hadden we alleen toegang tot een kant-en-klaar eindpunt, en nu maken en configureren we dit eindpunt zelf. Om te configureren moet u opgeven:

1. Request method. In dit voorbeeld is dat de methode GET.
2. Request URL. Het eerste deel met het pad naar de server is niet gespecificeerd. Het is hetzelfde voor alle applicatie-eindpunten. Het is voldoende om alleen de uitgang (/city) te specificeren. Ook de URL-parameter wordt hier gespecificeerd. Het eindpunt is ontworpen om informatie over een bepaalde stad te ontvangen, dus wordt zijn id, geschreven na ":", doorgegeven als parameter.
3. Endpoint Groups. Deze parameter heeft geen enkele invloed op de werking van het eindpunt en is alleen bedoeld voor het gemak van de organisatie. Alle eindpunten kunnen worden ingedeeld in thematische groepen (mappen). In dit voorbeeld bevat de groep "city" alle eindpunten voor het werken met gegevens over steden.
4. Business Process. Dit is het belangrijkste configuratie-item en is op geen enkele manier zichtbaar wanneer een verzoek naar het eindpunt wordt gestuurd. De aanduiding van het bedrijfsproces bepaalt wat dit endpoint gaat doen. Tegelijkertijd kan het endpoint zelf ongewijzigd blijven, het zal dezelfde verzoeken ontvangen op het oude adres, en tegelijkertijd, als het bedrijfsproces wordt vervangen, een geheel andere functie uitvoeren. Bedrijfsprocessen voor basis database activiteiten worden automatisch aangemaakt. Zij worden systeembedrijfsprocessen genoemd. Dergelijke BP's kunnen niet worden gewijzigd, maar kunnen te allen tijde worden vervangen door zelfstandig aangemaakte BP's, met aangepaste bedrijfsprocessen.
5. Input/Output variables. Het aangemaakte bedrijfsproces gebruikt verschillende in- en uitgangsvariabelen, maar het eindpunt hoeft ze niet allemaal te gebruiken. Een deel kan worden uitgeschakeld of geconfigureerd zodat verschillende eindpunten toegang hebben tot dezelfde BP, met een individuele set variabelen. Het request en response type (Request / Response type) wordt daar ook geconfigureerd. Meestal zal dit type JSON zijn, maar indien nodig kunnen andere opties worden gebruikt, zoals XML of Render File (dit type antwoord wordt gebruikt in eindpunten voor het werken met bestanden).

Middleware-instellingen

Algemene instellingen zijn voldoende voor het aanmaken en verder gebruiken van het eindpunt, maar indien nodig kunnen aanvullende parameters worden gebruikt. De belangrijkste daarvan is de activering van Middleware met een Auth token.

Door het gebruik ervan kunt u de toegang tot dit eindpunt ontzeggen aan gebruikers die niet geautoriseerd zijn of niet tot een bepaalde groep behoren (bijvoorbeeld, toegang kan alleen worden verleend aan beheerders en geweigerd aan andere gebruikers).

Logboek- en uitvoerinstellingen

Bovendien kunt u de instellingen op het tabblad Settings gebruiken om de headers of de request body extra te loggen, en om de velden waarvan de waarden niet zijn ingesteld uit het antwoord te verbergen.