Abgabe docs and tag
Reichen sie den finalen Stand ihrer Projektarbeit als Link auf ihr Gitlab-Repository ein. Dort muss ein Tag "abgabe" gesetzt sein, dieser Stand wird bewertet.
Das Repository muss folgende Dateien enthalten:
Alle Quelltextdateien ihres Projekts CI/CD-Konfiguration für Gitlab Test-Suite, welche per CI/CD ausgeführt wird Dockerfile(s) YML-Dateien für die Installation im Kubernetes-Cluster YML-Datei der OpenAPI-Spezifikation Das Projekt muss zusätzlich über eine grundlegende Inline-Dokumentation verfügen, welche das Verständnis der Code-Struktur und der Designentscheidungen ohne zusätzliche mündliche Erklärungen erlaubt. Eine Dokumentation für Endanwender ist, über die OpenAPI-Spezifikation hinaus, nicht erforderlich.
Die Dokumentation sollte nach dem Checkout des Repository den Dozenten in die Lage versetzen, ihr Projekt lokal als Docker-Image unter Linux (X64) zu bauen und auszuführen. Eventuell notwendige Abhängigkeiten zu anderen APIs für die anschliessende Ausführung, inkl. der etwaigen Aktivierung von Mocks, sind entsprechend zu dokumentieren.
Der Kernaspekt für die Bewertung des Codes ist die Integration / Anwendung von Erkenntnissen aus den Vorträgen und Diskussionen. Dies umfasst u.a. die folgenden Punkte:
Übereinstimmung der OpenAPI-Spezifikation mit dem Code-Verhalten Geeignete Fehlerbehandlung für ein komplexes verteiltes System Berücksichtigung von Container-Neustart zu jedem beliebigen Zeitpunkt Geeignete Log-Ausgaben für eine Fehlersuche im Betrieb Berücksichtigung von Authentifizierung und Authorisierung Berücksichtigung von Skalierbarkeit bei der Granularität der REST-Funktionen Geeignete Realisierung von Software-Konfiguration für eine Microservice-Umgebung Programmiersprache und -stil sind hier sekundär.