Umstieg von json auf yaml

Zur verbesserten Nutzbarkeit der OpenAPI-Spec ist ein Umstieg von json auf yaml zu evaluieren.

@Andreas_Huber: Spricht hier aus Ihrer Sicht etwas dagegen?

Ich finde JSON besser lesbar. Was sind denn die Vorteile von YAML?

Beim Editieren der Spezifikation außerhalb eines Spezifikationstools (z.B. mit einfachem Texteditor) erlaubt die Verwendung von YAML das einfachere Editieren (insb. kopieren/verschieben von API-Endpunkten).

Update 2021-02-11: YAML scheint sich gerade in der Verwaltung und auch darüber hinaus als vorherrschendes Datenschema durchzusetzen (z.B. http://payment.infra-lab.de/, PVOG). Daher Entscheidung für YAML. YAML und JSON können bei Bedarf verlustfrei ineinander konvertiert werden. Im API-Portal sollen sowohl yml-, als auch json-Spezifikationen zum Download bereitstehen (automatisierte Generierung via GitLab CI).

assigned to @Andreas_Huber

marked this issue as related to #26 (closed)

Erledigt in v1 im Branch https://git.fitko.de/fit-connect/FIT-Connect-PoC/-/tree/api-v1-migration/spec

closed