API-Spezifikation: Automatisierte Prüfung von API-Guidelines
Warum machen wir das?
Auf Basis der Italienischen API Guidelines soll eine automatisierte Prüfung der Schnittstellenspezifikation durchgeführt werden, um die Qualität der Spec kontinuierlich zu monitoren.
Relevante Informationen
- siehe https://italia.github.io/api-oas-checker/
- Die Prüfungen können mit spectral automatisiert via CI ausgeführt werden: https://git.fitko.de/fit-connect/submission-api/-/blob/main/.gitlab-ci.yml?ref_type=heads#L32
Akzeptanzkriterien
-
Es existiert eine CI, die die Italienischen API Guidelines automatisch prüft. -
Ausnahmen von einzelnen Guidelines können mit entsprechender Begründung definiert werden. Vgl. https://git.fitko.de/fit-connect/submission-api/-/blob/main/.spectral.yml?ref_type=heads
Durchführungsplan
-
... -
... -
...
Edited by Felix Bernhardt