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

112 Umsetzung des Prototyps
Ursprünglich wurde eine externe Bibliothek namens ruby-hmac für die Berechnung der SHA1-256
Hashwertes angewendet, welche eine wesentlich geringere Performanz zeigt 20 .
Nachdem die wesentlichen Aspekte der Umsetzung der REST API vorgestellt wurden, werden in
den kommenden Abschnitten Details gegeben über die Aufstellung der API mithilfe eines Web Servers
sowie die Beschreibung der verfügbaren Routes als die Beantwortung einer OPTIONS Anfrage.
Beschreibung und Entdeckung von REST Web Services
Ein grundlegendes Prinzip des Grape mini-Frameworks ist die Kompilierung von Routen, ein Prinzip
welches auch anderen Web Frameworks zugrunde liegt. Der Name dieser Technik deutet an, dass
die definierten Routen eines REST APIs bevor die Aufstellung (engl. deployment) auf einem Web
Server “abgeschlossen” werden müssen. Das heißt, es können außer der “abgeschlossenen”, finalisierten
Routen keine andere Route behandelt. Zu diesem Zweck werden alle deklarierten Routen
einer REST API in einer Rack-konforme Anwendung zusammengefasst. Durch die Kompilierung der
Routen werden diese stets statisch (Routen können auch anhand von variablen Parametern wie z.B.
POST /model/:action/:id definiert werden. Diese Route besagt, dass die Parameter namens
“action” und “id” aus der ankommenden Anfrage auszulesen sind), was die Bedeutung von “auswertbar”
enthält.
Die “Auswertung” der Routen wird auch von einem Grape-Plugin 21 benutzt. Dieses Plugin dient
als ein Dokumentations-Werkzeug für die Beschreibung einer mit Grape definierten REST API und
kann mit dem “Swagger” 22 Werkzeug zum Testen von Web Services zusammenarbeiten. Anhand des
Prinzips der Routen-Kompilierung wurde in dieser Arbeit eine Erweiterung zur Beschreibung und
eventuelle Entdeckung vorhandener REST Web Services, definiert, welche im Folgenden beschrieben
wird.
Durch Metaprogrammierung wurden in vorhandenen REST APIs (bzw. BaseAPI sowie Basic-
ModelAPI) grundlegende HTTP Methoden zur Beschreibung der Funktionalität der entsprechenden
API eingeführt. Beispielsweise liefert die Anfrage OPTIONS / eine JSON-kodierte Array mit dem
folgenden Format zurück:
[version: “v1”, method:“GET”, path:“/:version/set/visited(.:format),
version: “v2”, method:“DELETE”, path:“/:version/:id/:recurse(.:format)]
Hiermit wurde durch das Hash erkenntlich gemacht, welche Routen für die ausgewählte Namespace
verfügbar sind. Dabei enthalten sind alle benötigten Informationen: die Version der API, die zu
benutzende HTTP Methode sowie das erwartete Format der URI.
Die Entdeckung vorhandener Services könnte mittels derselben vorgestellten Lösung erreicht werden:
durch wiederholte Formulierungen von OPTIONS Anfragen (anfänglich an einen Dienst-Gateway
und darauffolgend gezielt an eine Namespace von Interesse) könnten theoretisch neue durch REST
Web Services veröffentlichte Dienste entdeckt werden.
20 Artikel “OpenSSL::HMAC vs ruby-hmac Benchmarks”, Erscheinungsdatum: 04. Dez 2008, http://blog.
nathanielbibler.com/post/63031273/openssl-hmac-vs-ruby-hmac-benchmarks
21
https://github.com/tim-vandecasteele/grape-swagger
22
http://swagger.wordnik.com/