Swagger OpenAPI Dokumentation fehlerhaft

Rüdiger Kern

Liebes Churchtools Team,

ich gehöre mit meiner Gemeinde zu den Newcomern bei Churchtools.
Ich bin begeistert, das es eine REST API gibt, über die wir beispielsweise speziell formatierte Adresslisten nach wir vor generieren können.

Nun habe ich versucht mit der 'system/runtime/swagger/openapi.json' Ausgabe die Java Klassen für einen Client zu generieren (zur Einbindung in Spring-Boot). Leider hat das, auch mit vielen Mühen, überhaupt nicht geklappt (mit keinem der verfügbaren Generatoren).
Die ausgegebene OpenAPI JSON Datei weist leider so viele Fehler auf, dass sie praktisch nicht verwendbar ist. - Ein einfacher Test mit dem Editor auf editor.swagger.io zeigt schon eine ganze Menge an Fehlern. Des weiteren werden die generierten Schemas überhaupt nicht in den Responses per $ref referenziert. Das führt bei der Generierung zu jeder Menge an Klassen aus InlineResponses mit generischen Namen, was die ganze Sache sehr unübersichtlich macht und Duplikate produziert.

Ich habe den Ansatz aufgegeben und definiere jetzt erst mal nur die API's, die ich im Moment benötige.

Für Eure Unterstützung wäre ich dankbar.

Vielen Dank und liebe Grüße,
Rüdiger Kern.

hgransow

Hi in die Runde,
ich schließe mich da an, die Swagger OpenAPI-Beschreibung ist ziemlich korrupt und eignet sich leider im aktuellen Zustand nicht zum Generieren von Java-Klassen... Da habe ich ebenfalls einige Stunden investiert, frustriert aufgegeben und meine eigenen Java-Klassen der APIs geschrieben, die ich benötige.
Es wäre jedoch super, wenn ihr da noch nachfeilen könntet, liebes ChurchTools Team

Liebe Grüße
Hendrik

hbuerger

Danke für das Feedback. Ich werde mir das mal angucken.

skipy

Ich kann mich da meinen Vorrednern nur anschließen. Es macht leider echt keinen Spaß und ist defakto fast unmöglich mit der Openapi.json zu arbeiten, weil so viele Fehler drin sind. Zudem bin ich etwas frustriert, was die Antwortzeiten angeht, wenn man einen Fehler in der Openapi.json meldet.

@hbuerger Was war das Ergebnis vom "angucken"?

Hat sich da seit April was getan?
Möchtet ihr, dass wir als Entwickler aktiv Fehler melden oder empfindet ihr das eher als nervig?
Wie können wir als externe Entwickler diese Fehler so melden oder sogar selbst korrigieren, dass sie schneller im Produktiv-System landen?