Fachhochschule Nordwestschweiz FHNW

aWall GitLab Integration - A Best Practice REST-API Design Approach

Zusammenfassung

Das Projekt befasst sich mit der Konzipierung einer neuen REST-API nach Best Practices um die aWall-Applikation um eine GitLab-Anbindung erweitern zu können.

Schlüsselbegriffe

REST
API
OAS
CI/CD
Versionierung
Best Practices
GitLab
JIRA
Testing
Design
Python
Flask

Zielsetzung

Mit einem klaren Test- und Versionierungskonzept soll die aWall REST-API sowohl die Anbindung von JIRA als auch GitLab ermöglicht und werden. Dabei sollen folgende Forschungsfragen generell untersucht werden:

Welche Schritte sind nötig, um eine saubere Versionierung einer REST-API zu garantieren?
Welche Voraussetzungen müssen gegeben sein, dass die Qualität einer REST-API durch automatisiertes Testing sichergestellt werden kann?

Ausgangslage

aWall ist ein fortlaufendes Forschungsprojekt des Instituts für Mobile und Verteilte Systeme an der Fachhochschule Nordwestschweiz, zur Erforschung und Unterstützung der agilen Teamarbeit in Software-Projekten. Das aWall REST-API orientiert sich aktuell noch stark am REST-API-Modell von JIRA. Durch eine evolutionäre Weiterentwicklung entstanden Inkonsistenzen und Redundanzen im Ressourcen-Modell. Zudem existiert kein REST-Konzept welches heutigen Standards folgt. Zukünftig sollen auch noch andere Issue-Tracking Systeme als Backend-Systeme verwendet werden.

Ergebnisse

Unter Betrachtung von verschiedenen Best Practices, konnte aus den gewonnenen Erkenntnissen unteranderem ein Lösungskonzept in Form einer Open-API-Spezifikation (basierend auf einem konsolidierten Ressourcen-Modell, und einer neuen REST-API) sowie einem Test-Konzept entworfen werden. Dieses wurde anschliessend als Proof of Concept in die aWall-Applikation implementiert.

Es wurde erkannt, dass für eine saubere Versionierung die Wahl einer geeigneten Versionierungsstrategie, die Abbildung der Version und das Publizieren von Änderungen berücksichtigt werden müssen.
Um die Qualität durch automatisiertes Testing sicherzustellen, bedarf es einer semantisch korrekten sowie vollständigen Spezifikation der REST-API, woraus sich mögliche Test-Szenarien ableiten lassen. Ebenso ist eine CI/CD Umgebung unbedingt erforderlich.