Skip to content

Sicherstellung Schemakonformität von Implementierungen gegen die API-Spezifikationen

Warum?

In #87 (closed) wurde eine entsprechende Prüfung einmalig und manuell durchgeführt.

Um Implementierungsfehler zu identifizieren und zu vermeiden, sollen die Implementierungen nun automatisiert gegen ihre API-Spezifikation getestet werden.

Relevante Links und Bemerkungen

  • siehe Vorarbeiten aus #87 (closed)
  • kann z.B. mit Schemathesis erfolgen

Akzeptanzkriterien

  1. Eine Prüfung findet automatisiert und regelmäßig statt.
  2. Alle Implementierungen der FIT-Connect APIs werden gegen ihre Spezifikation geprüft.
  3. Es ist ein Prozess definiert, wie mit Verletzungen der API-Spezifiaktion umgegangen wird und es ist sichergestellt, dass die Schema-Konformität durch diesen Prozess sichergestllt wird (z.B. fehlschlagende CI).
  4. Optional: Wir erklären unser Vorgehen in einem Blogpost und ermöglichen so anderen Projekten, unsere Lösung zu übernehmen.

Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)