Endpunkte sind ein wesentlicher Bestandteil von Geschäftsprozessen und der Anwendungsentwicklung im Allgemeinen. In diesem Artikel definieren wir, was Endpunkte sind, warum wir sie brauchen und wie man sie auf der AppMaster.io-Plattform erstellt.
Was ist ein Endpunkt?
Ein Endpunkt ist ein Gateway, das die Serverprozesse der Anwendung mit einer externen Schnittstelle verbindet. Mit anderen Worten, dies ist die Adresse, an die Anfragen gesendet werden.
Um zu verstehen, was Endpunkte sind, ist es wichtig zu erwähnen, wie die API funktioniert. API ist eine Abkürzung für eine Anwendungsprogrammierschnittstelle. Anwendungen verwenden APIs, um mit Diensten von Drittanbietern und deren Nutzern zu interagieren.
Um eine Verbindung zur API herzustellen, müssen Sie eine Anfrage senden. Für die korrekte Verarbeitung der Anfrage muss der Client einen Universal Resource Pointer (URL), eine HTTP-Methode und, je nach Methode, Header, Body und Anfrageparameter hinzufügen. Die Header liefern Metadaten über die Anfrage, während der Body Daten enthält, z. B. Felder für neue Zeilen in der Datenbank.
Die API verarbeitet die Anfrage und sendet die vom Server erhaltene Antwort. Die Antwort enthält einen Statuscode, der ein Teil der HTTP-Antwortnachricht ist und den Client über das Ergebnis der Anfrage informiert. Beispielsweise wird der Code 200 verwendet, wenn der Vorgang erfolgreich abgeschlossen wurde, 500, wenn ein interner Serverfehler aufgetreten ist.
Endpunkte arbeiten mit API-Methoden zusammen. Dabei handelt es sich um spezifische URLs, die die Anwendung für die Kommunikation mit Diensten von Drittanbietern und ihren Benutzern verwendet. Eine URL ist eine Route, die verschiedene Anfragemethoden verarbeiten kann. Jeder Anforderungstyp ist ein eigener Endpunkt. Es gibt fünf Haupttypen:
- GET - holt Informationen vom Server; es ist kein Anfragebody erforderlich;
- POST - erstellt ein neues Objekt in der Datenbank, erfordert einen Anfragebody mit den Feldern dieses Objekts;
- PUT - setzt ein bestimmtes Objekt vollständig in der Datenbank zurück;
- PATCH - ähnlich wie PUT, setzt ein bestimmtes Objekt in der Datenbank zurück, aktualisiert aber nur die Felder, die im Anfragebody erwähnt werden;
- DELETE - löscht das Objekt aus der Datenbank.
Bei der Erstellung einer spezifischen Anfrage können verschiedene Parameter hinzugefügt werden. Die Kombination aus diesen Parametern und der URL stellt einen URI - Uniform Resource Identifier - dar. Er gibt an, wo und wie die Ressource zu finden ist.
Wie können Sie Endpunkte auf der AppMaster.io Plattform konfigurieren?
Im Abschnitt Endpunkte der AppMaster.io Plattform können Sie alle automatisch generierten Endpunkte und die Endpunkte Ihres Projekts sehen. Wenn die automatische Generierung von Bildschirmen und Seiten in Ihrem Projekt aktiviert ist, werden automatisch die entsprechenden Endpunkte für jedes erstellte Datenmodell erstellt. Auch können Endpunkte automatisch erstellt werden, wenn Sie einige Module installieren, z.B. Autorisierung (Auth), Länder und Städte, und andere.
AppMaster.io ermöglicht es Ihnen, mit verschiedenen Arten von Endpunkt-APIs zu arbeiten:
- API für den Zugriff auf das Backend vom Client und von Drittsystemen aus;
- Webhooks für den Empfang von Benachrichtigungen von Drittsystemen;
- WebSockets, um eine interaktive Zwei-Wege-Kommunikationssitzung zwischen einem Browser und einem Server zu eröffnen, ohne den Server um eine Antwort zu bitten.
Alle Endpunkte sind in Gruppen zusammengefasst. Innerhalb jeder Gruppe finden Sie alle entsprechenden Endpunkte, ihre Anfragearten, URLs und die Geschäftsprozesse, mit denen sie verbunden sind. Alle Endpunkte können von Ihnen gelöscht und bearbeitet werden.
Bei der Erstellung oder Bearbeitung eines Endpunktes stehen Ihnen im Konfigurationsfenster folgende Optionen zur Verfügung:
- Request-Methode. GET, POST, PUT, DELETE oder PATCH.
- Anforderungs-URL. Der erste Teil mit dem Pfad zum Server wird nicht angegeben, da er für alle Anwendungsendpunkte gleich ist. Es genügt, das Ende anzugeben, zum Beispiel /users. Auch der URL-Parameter wird hier angegeben. Angenommen, der Endpunkt soll Informationen über einen bestimmten Benutzer erhalten. In diesem Fall muss seine ID nach ":" geschrieben werden (/users/:id) und als Parameter übergeben werden.
- Endpunktgruppen. Dieser Parameter dient der Organisation und Strukturierung der Arbeit mit Endpunkten. Alle Endpunkte können in Gruppen (Ordner) unterteilt werden.
- Geschäftsprozess. Einer der wichtigsten Parameter, die bestimmen, was der Endpunkt tun wird. Zugleich kann der Endpunkt selbst unverändert bleiben. Er empfängt die gleichen Anfragen unter der alten Adresse, und wenn der Geschäftsprozess ersetzt wird, führt er eine andere Funktion aus. Geschäftsprozesse für grundlegende Datenbankoperationen werden automatisch erstellt. Sie können sie nicht bearbeiten, aber bei Bedarf durch benutzerdefinierte GPs ersetzen.
Außerdem können Sie Middleware einrichten. Middleware ist eine zwischengeschaltete Software, die bei der Verarbeitung von Anwendungsanfragen als Filter dient. Middleware wird verwendet, um alle Bedingungen zu prüfen, bevor eine Anfrage ausgeführt wird. Wenn Sie beispielsweise eine Middleware zur Überprüfung der Benutzerauthentifizierung erstellen, leitet die Middleware den Benutzer auf die Anmeldeseite um, wenn er nicht angemeldet ist. Wenn er angemeldet ist, greift die Middleware nicht in die Verarbeitung der Anfrage ein, sondern leitet sie an den Client weiter.
Erstellen eines Endpunktes in AppMaster.io
Lassen Sie uns die Konfiguration von Endpunkten in der Praxis betrachten und am Beispiel des Aviato-Projektes analysieren. Den kompletten Prozess der Erstellung dieses Projekts finden Sie im AppMaster.io-Kurs.
In dem Projekt haben wir zwei Geschäftsprozesse erstellt:
- Flüge validieren und erstellen - der Prozess, der den Geschäftsprozess Flug erstellen ersetzen wird;
- Passagier registrieren - für die Registrierung eines Passagiers für einen bestimmten Flug.
Nun können wir diese Prozesse verwenden, um Endpunkte im Projekt einzurichten.
Beginnen wir mit dem Geschäftsprozess "Validate and create flights". Die Fluggruppe hat bereits einen POST/flights Endpunkt für die Erstellung eines Fluges. Nun müssen wir den angehängten Geschäftsprozess durch einen neuen ersetzen. Dazu müssen wir den Endpunkt bearbeiten.
Im Konfigurationsfenster wählen Sie den gewünschten Geschäftsprozess aus. In unserem Fall handelt es sich um den Geschäftsprozess "Validate and create flights". Danach müssen wir alle benötigten Eingabevariablen auswählen und die Änderungen speichern.
Nun können wir den nächsten Endpunkt für den Geschäftsprozess "Passagier registrieren" einrichten.
Unser Ziel ist es, einen Bereich zu erstellen, in dem ein bestimmter Flug und die damit verbundenen Passagiere angezeigt werden, und einen Prozess für die Registrierung neuer Passagiere einzurichten.
In der Endpunktgruppe "Flüge" müssen wir einen neuen Endpunkt erstellen: /flights/:id/register, wobei id auf einen bestimmten Flug verweist, den wir als Eingabe in einem Geschäftsprozess verwenden können.
Durch Klicken auf das Plus-Symbol können wir einen neuen Endpunkt hinzufügen. Die Anforderungsmethode ist POST, da wir ein neues Objekt erstellen. Wir wählen den Prozess Passagier registrieren für unseren GP aus und speichern alle vorgenommenen Änderungen.
So einfach ist es, Endpunkte auf der AppMaster.io-Plattform zu erstellen. Vollständiges Video-Tutorial:
Schlussfolgerung
Endpunkte spielen eine wichtige Rolle für den Betrieb der API, die wiederum für die Erweiterung von Projekten und die bequeme Integration von Diensten und Anwendungen notwendig ist. Die No-Code-Plattform AppMaster.io macht es einfach, mit Endpunkten zu arbeiten, sie zu erstellen und zu konfigurieren. Sie können sich jederzeit auf der Plattform registrieren und alle Funktionen ausprobieren.
