LU08a - Schnittstellendokumentation

Da in grösseren Entwicklungsteams oft unterschiedliche Leute an Front- und Backend arbeiten, ist eine entsprechende Dokumentation der Schnittstellen (z. B. REST APIs) unabdingbar. Dadurch wird sichergestellt, dass die Schnittstellen seitens Backend korrekt implementiert und seitens Frontend korrekt verwendet werden.

OpenAPI (https://www.openapis.org/) ist ein gebräuchlicher Standard, um APIs in einer JSON- oder YAML-Datei zu spezifizieren. Diese Datei kann abgesehen als Dokumentation auch genutzt werden, um …

1. Teile des Servers zu generieren
2. Teile des Clients zu generieren
3. mit Postman die APIs zu testen

Machen Sie im Accounting-App-Projekt einen cherry-pick auf TODO um im Verzeichnis documentation/ die Datei openapi.yaml zu erhalten.

Swagger (https://swagger.io/)