Download (5Mb) - oops/ - Oldenburger Online-Publikations-Server

7.3 Backend 107
Grape ermöglicht die Definition einer REST API durch die Bereitstellung eines “Micro-Frameworks”.
Nachdem eine API definiert ist, kann diese Spezifikation auf einem Rack-kompatiblen Web Server installiert
und den Client-Anwendungen angeboten werden. Grape unterstützt häufig verwendete Konzepte,
die mit der Definition einer REST API verbunden sind, wie z.B. verschiedene Repräsentationen
oder Formate: Die Anfrage an eine URI wie http://localhost/api/index.html liefert
z.B. eine andere Antwort als eine Anfrage an die http://localhost/api/index.json)
URI. Weiterhin unterstützt Grape die Versionierung einer API, durch die Einbettung der aktuellen Version
in die URI (http://localhost/api/v8/etc) – alternativ können HTTP Headers oder
Parameters verwendet werden.
Weiterhin können verschiedene Namensräume (engl. namespace) definiert werden, in dem die beschriebenen
Routen ihre Einzigartigkeit behalten – z.B. bei der Definition der Namensräume “foo”
und “bar” werden die Anfragen “GET /foo/my-action” und “GET /bar/my-action” dem entsprechenden
Namensraum weitergeleitet bzw. geroutet.
Nachdem die benutzte technologische Grundlage für die Bereitstellung von REST APIs kurz eingeführt
ist, werden in den kommenden Abschnitten Implementierungsdetails über die Umsetzung der
Kommunikation zwischen dem Backend und dem Frontend gegeben.
Definition einer Basis-API
Ein erster Schritt für die Gewährleistung der Allgemeinheit im Fall der zu entwickelnden REST
API ist die Definition einer Basis-API, die allgmein gültige Einstellungen feststellt. Diese Einstellungen
werden per Ruby “Einbeziehung” (engl. inclusion, Ruby Schlüsselwort include) in die
jeweiligen spezialisierten APIs integriert.
Die genannten Einstellungen berühren REST- und HTTP-spezifische Themen, wie z.B. die Benutzung
einer einheitlichen Versionnummer für API Methoden (s.o.), die Benutzung einer Default-
Repräsentation oder die Feststellung eines Default Content-Type. Darüber hinaus werden in der
Basis-API verschiedene Grape-spezifische Einstellungen ausgeführt wie die “stumme” Beseitigung
eintretender Exceptions durch Logging (siehe auch 7.3.6).
Die Basis-API enthält auch eine Basis-Funktionalität, die von erbenden APIs benutzt werden können:
eine Methode zur Serialisierung (s.u.) und ggf. Komprimierung des übergebenen Inhalts. Weiterhin
ist die Basis-API für erweiterte Konfigurationen zuständig, wie z.B. die Installation einer
Rack-Middleware für die Implementierung des HMAC-basierten Sicherheitskonzeptes (siehe auch
den kommenden, dedizierten Paragraph).
Die genannten Einstellungen werden dank einem Feature von Ruby automatisch durchgeführt bei
der Vererbung der Klasse BaseAPI von einer spezialisierten Klasse. Wie bei einer normalen Vererbung,
bleiben die Einstellungen der Vater-Klasse bestehen, während die spezialisierte Klasse eine
eigene REST API definiert. Weitere Details zur Spezialisierung werden in einem kommenden Abschnitt
gegeben werden.
Definition einer erweiterten API für die Einkapselung beliebiger Bestandteile des Datenmodells
Die Spezialisierung der BaseAPI Klasse wird durch die Bestandteile des Datenmodells (siehe
auch 7.2) ausgeprägt und ist in der Basis-Klasse BaseModelAPI zusammengefasst. Zum Beispiel