4D bietet einen leistungsstarken REST-Server, der den direkten Zugriff auf die in Ihren 4D Datenbanken gespeicherten Daten ermöglicht. So können Sie beispielsweise eine API erstellen, die mit einer modernen Front-End-Technologie(z.B. Angular, React, etc.) verwendet werden kann. In diesem Blogbeitrag geben wir Ihnen eine erste Einführung in den 4D Robust REST Server. Sie erfahren, wie Sie ihn konfigurieren und die CRUD-Operationen (Create, Retrieve, Update und Delete) mit dem API-Testtool Postman testen.
Konfigurieren Sie den REST Server
HINWEIS: Wenn Sie bereits wissen, wie Sie einen REST Server und eine 4D Datenbank konfigurieren, können Sie die nächsten beiden Abschnitte überspringen.
Um den 4D REST Server nutzen zu können, müssen Sie ihn zunächst konfigurieren (ein einziger Klick, um ihn zum Laufen zu bringen). Aktivieren Sie einfach die Option „Expose as REST server“ auf der Seite „Web/REST resource“ in den Datenbankeinstellungen, damit REST Anfragen verarbeitet werden können:
Erstellen und Konfigurieren der 4D Datenbank
- Dieser Schritt setzt voraus, dass Sie bereits eine Datenbank erstellt und den Rest-Server aktiviert haben. Gehen Sie zu Ihrer Struktur und erstellen Sie eine neue Tabelle [Tasks] mit zwei Attributen: Titel (Alpha) und Vollständig (Boolesch). Standardmäßig sind alle Tabellen in REST verfügbar:
Wichtig: Tabellen- und Feldnamen müssen JSON-konform sein (keine diakritischen Zeichen oder Leerzeichen).
- Erstellen Sie nun Eingabe- und Ausgabeformulare. Geben Sie einige Aufgaben in die Tabelle Aufgaben ein.
- Wählen Sie im Menü Ausführen die Option Webserver starten (falls er nicht bereits gestartet ist) und dann Webserver testen.
- Herzlichen Glückwunsch! Sie können jetzt Daten in 4D lesen und bearbeiten, indem Sie nur REST-Anfragen verwenden.
Wie können Sie das feststellen? Ganz einfach: Öffnen Sie einen Webbrowser und fügen Sie nach ADDRESS:PORT„/rest“ ein. (Alle 4D REST URL-Anfragen beginnen mit /rest).
Wenn Sie zum Beispiel alle Entitäten der Datenklasse [Aufgaben] abrufen möchten, können Sie wie folgt vorgehen:
Testen der API mit Postman
Das Erstaunliche am 4D REST Server ist, dass die API die CRUD-Operationen(und mehr!) bereitstellt… und das sofort! Zum Erstellen, Lesen, Aktualisieren oder Löschen einer Entität ist nicht eine einzige Codezeile erforderlich. Alles ist für Sie vorbereitet. Wie wir alle wissen, ist CRUD die wichtigste Gruppe von Datenbankoperationen, da es sich dabei um die Hauptfunktionen handelt, die Benutzer zum Erstellen und Verwalten von Daten benötigen.
Um diese erstaunliche API zu testen, verwenden wir Postman (ein hervorragendes Tool zum Testen von RESTful APIs). Postman bietet eine elegante Benutzeroberfläche für HTML-Anfragen wie GET, POST, PUT/UPDATE, DELETE und verschiedene andere Abfrageverfahren.
Hinweis: Die Verwendung von Postman ist einfach, aber schauen Sie sich dieses Video an, wenn Sie Hilfe bei den ersten Schritten benötigen.
GET die Liste der Aufgaben
Sobald Postman heruntergeladen ist, starten Sie es, und wir erstellen unsere verschiedenen Anfragen. Wir beginnen mit der offensichtlichsten Anfrage: Abrufen der Liste der Aufgaben (aus unserer Tabelle [Aufgaben]). Wie bereits erwähnt, müssen Sie, um alle Entitäten der [Tasks]-Datenklasse zu erhalten, nach ADDRESS:PORT /rest/NamederDatenklasse einfügen.
- Wählen Sie die Methode GET aus der Liste der Methoden
- Kopieren Sie die URL
- Klicken Sie auf Senden
- Voilà:
Wie Sie sehen können, ist keine einzige Zeile Code erforderlich, um die Liste der Aufgaben abzurufen!
Eine neue Aufgabe erstellen
Wir können auch eine neue Aufgabe zu unserer Datenklasse hinzufügen … ebenfalls ohne Code. Die API ist bereits für Sie eingerichtet!
Um eine neue Entität zu erstellen, wird diese URL eine neue Post-Anfrage auslösen: ADDRESS:PORT/rest/NamederDatenklasse/?$method=update. Dazu müssen wir eine JSON-Anfrage an die Anwendung senden. Wenn Sie die Ergebnisse der GET-Anfrage überprüfen, erhalten Sie eine Vorstellung von den Schlüsseln, die für die Erstellung einer neuen Aufgabe erforderlich sind. Nach dieser Logik brauchen wir also nur den Titel und die vollständigen Felder; 4D kümmert sich um den Rest (Schlüssel, Zeitstempel, Stempel und ID).
- Ändern Sie die Methode in POST
- Fügen Sie die URL ein
- Klicken Sie auf Senden
- Fügen Sie Ihre neue Aufgabe hinzu
- Stellen Sie sicher, dass success = true ist!
Gehen Sie zurück zur ersten Registerkarte (GET-Methode), klicken Sie auf Senden und überprüfen Sie, ob die Aufgabe hinzugefügt wurde. Sie können auch Ihr 4D Ausgabeformular aufrufen, um zu sehen, ob die neue Aufgabe hinzugefügt wurde!
Aktualisieren einer Aufgabe
Um eine Entität zu aktualisieren, verwenden wir die gleiche Methode, die wir beim Erstellen der Entität verwendet haben. Mit $method=update können Sie eine oder mehrere Entitäten in einem einzigen POST aktualisieren. Dazu müssen Sie die Parameter __KEY und __STAMP zusammen mit allen geänderten Attributen an das Objekt übergeben.
In unserem Beispiel sind wir mit der Lektüre eines der bekanntesten Werke von Hemingway fertig: The Old Man and the Sea. Daher müssen wir den vollständigen Status der Aufgabe in true ändern. Einfach:
Löschen einer Aufgabe
Das Löschen einer Entität ist ebenfalls sehr einfach. In unserem Beispiel wollen wir die Aufgabe mit ID = 3 (genannt „test“) löschen. Das ist kein Problem! Rufen Sie die Löschmethode auf und geben Sie die ID der Aufgabe an: dataclass(ID)?$method=delete.
Gehen Sie zurück zu Ihrer 4D Datenbank und überprüfen Sie, ob die Entität gelöscht wurde! Sie ist verschwunden, oder?
Wie geht es weiter?
Wie Sie sehen, ist der 4D REST Server sehr mächtig. Er bietet eine umfangreiche API, die über das hinausgeht, was wir gerade gezeigt haben. Es gibt noch viel mehr, was in kurzer Zeit gemacht werden kann. Sehen Sie sich die ausführliche Dokumentation an. In den nächsten Blog-Beiträgen werde ich einen Tipp zur Authentifizierung geben und dann eine vollständige Front-End-Anwendung in ReactJS mit REST für den Web-Zugriff auf die 4D Datenbank vorstellen.