Allgemeine Informationen

Das letzte Modul endete mit der Erstellung des ersten Geschäftsprozesses. Wir haben herausgefunden, wie man eine Prozesslogik erstellt, bestimmte Eingabeparameter akzeptiert, Berechnungen durchführt und eine Antwort ausgibt. Nun bleibt noch die Hauptfrage zu beantworten. Wie aktiviert man den erstellten Geschäftsprozess und nimmt ihn in Betrieb?

Um dieses Problem zu lösen, sind Endpunkte vorgesehen - Schlüsselpunkte der Interaktion mit der Anwendung. In den ersten Modulen haben wir bereits mit externen APIs interagiert. Dies war dank des Vorhandenseins von Endpunkten möglich. Sie wurden in der Dokumentation beschrieben, und wir haben sie gelesen und verstanden, welche Methode und welche URL notwendig ist, um eine Anfrage für den Zugriff auf eine bestimmte Ressource zu senden.

Zum besseren Verständnis wollen wir uns die Implementierung der Endpunkte anhand eines konkreten Beispiels ansehen. Im dritten Modul wurde das Datenbankmodell erstellt. Gleichzeitig mit der Erstellung der Tabellen wurden automatisch Endpunkte für die Interaktion mit den Tabellen erstellt. Gehen wir zum Abschnitt Endpunkte (auf der linken Seite) und sehen wir sie uns an.

Im Beispiel der Tabelle "city" mit Informationen über Städte kann man sehen, dass sie bereits 6 Endpunkte für grundlegende Datenoperationen hat.

• GET /city - Abrufen aller Daten aus einer Tabelle
• GET /city/:id - Abrufen von Daten über die Stadt mit der angegebenen ID
• POST /city - Hinzufügen eines neuen Datensatzes zur Tabelle
• PUT /city/:id - vollständige Ersetzung des Datensatzes mit der angegebenen ID in der Tabelle
• PATCH /city/:id - teilweises Ersetzen eines Datensatzes mit der angegebenen ID in der Tabelle
• DELETE /city/:id - Löschen eines Datensatzes mit der angegebenen ID aus der Tabelle

Allgemeine Einstellungen

Sie können die Einstellungen für jeden Endpunkt öffnen und ihn genauer untersuchen. Betrachten Sie zum Beispiel den Endpunkt GET /city/:id

Das Bild, das wir sehen, ist dem sehr ähnlich, das wir bereits beim Erstellen einer Anfrage an externe APIs gesehen haben. In einem Fall haben wir nur auf einen vorgefertigten Endpunkt zugegriffen, und jetzt erstellen und konfigurieren wir diesen Endpunkt selbst. Um zu konfigurieren, müssen Sie angeben:

1. Anfragemethode. In diesem Beispiel ist dies die Methode GET.
2. URL anfordern. Der erste Teil mit dem Pfad zum Server wird nicht angegeben. Er ist für alle Anwendungsendpunkte gleich. Es reicht aus, nur die Endung (/city) anzugeben. Auch der URL-Parameter wird hier angegeben. Der Endpunkt ist dazu bestimmt, Informationen über eine bestimmte Stadt zu erhalten, daher wird deren Kennung, die hinter ":" steht, als Parameter übergeben.
3. Endpoint Groups. Dieser Parameter hat keinen Einfluß auf den Betrieb des Endpunktes und ist nur für die Bequemlichkeit der Organisation gedacht. Alle Endpunkte können in thematische Gruppen (Ordner) unterteilt werden. In diesem Beispiel enthält die Gruppe "city" alle Endpunkte für die Arbeit mit Daten über Städte.
4. Business Process. Dies ist der wichtigste Konfigurationspunkt, der beim Senden einer Anfrage an den Endpunkt in keiner Weise sichtbar ist. Die Angabe des Geschäftsprozesses bestimmt, was dieser Endpunkt tun wird. Dabei kann der Endpunkt selbst unverändert bleiben, er empfängt alle Anfragen unter der alten Adresse, und gleichzeitig wird er, wenn der Geschäftsprozess ersetzt wird, eine völlig andere Funktion ausführen. Geschäftsprozesse für grundlegende Datenbankaktivitäten werden automatisch erstellt. Sie werden als Systemgeschäftsprozesse bezeichnet. Solche GPs können nicht geändert werden, aber sie können jederzeit durch unabhängig erstellte GPs mit benutzerdefinierten Geschäftsprozessen ersetzt werden.
5. Input/Output variables. Der erstellte Geschäftsprozess verwendet verschiedene Eingabe- und Ausgabevariablen, aber der Endpunkt muss nicht alle davon verwenden. Ein Teil kann deaktiviert oder so konfiguriert werden, dass verschiedene Endpunkte auf denselben GP mit einem individuellen Satz von Variablen zugreifen. Der Anfrage- und Antworttyp (Request / Response type) wird ebenfalls dort konfiguriert. In den meisten Fällen handelt es sich dabei um JSON, aber bei Bedarf können auch andere Optionen wie XML oder Render File verwendet werden (diese Art von Antwort wird in Endpunkten für die Arbeit mit Dateien verwendet).

Middleware-Einstellungen

Für die Erstellung und weitere Verwendung des Endpunkts reichen die allgemeinen Einstellungen aus, doch können bei Bedarf zusätzliche Parameter verwendet werden. Der wichtigste von ihnen ist die Aktivierung von Middleware mit einem Auth Token.

Seine Verwendung ermöglicht es, Benutzern, die nicht autorisiert sind oder nicht zu einer bestimmten Gruppe gehören, den Zugang zu diesem Endpunkt zu verweigern (z. B. kann der Zugang nur Administratoren gewährt und anderen Benutzern verweigert werden).

Einstellungen für Protokollierung und Ausgabe

Darüber hinaus können Sie die Einstellungen auf der Registerkarte Settings verwenden, um zusätzlich Header oder den Request Body zu protokollieren sowie die Felder, deren Werte nicht gesetzt sind, aus der Antwort auszublenden.