europace / baufismart-kundenangaben-api

API zum Importieren von Kundenangaben in einen neuen Vorgang in BaufiSmart.
https://developer.europace.de
14 stars 4 forks source link

YAML - Fehlende Einrückung der oneOf und allOf Definitionen - OpenAPI-Generator #92

Open flaxoiu opened 3 years ago

flaxoiu commented 3 years ago

Die bex-kundenangaben.api lässt sich leider nicht mit einem akutellen OpenApi-Generator der Version 5 generieren.

Beispiel: image

image

Mit Version 4.3.1 lässt sich die API und in der derzeitigen Struktur generieren.

acodingsquirrel commented 3 years ago

Hallo flaxoiu,

Wir bieten keinen Support für die Codegeneratoren an. Wir haben auch die Erfahrung gemacht, dass man manchmal noch Korrekturen vornehmen muss. Kannst du versuchen dir selbst zu helfen?

flaxoiu commented 3 years ago

Hallo,

naja, das Problem ist, dass wir unsere APIs gerne mit dem Code-Generator OpenAPITools/openapi-generator in Version 5.x generieren lassen würden (https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-maven-plugin)

Wenn ich jetzt manuell die komplette API-Specs-Datei ändere und Europace macht als API-Provider in der Yaml eine Änderung, dann kann der Client wieder alles manuell anpassen. Von dem her würde ich erwarten, dass der Provider eine kompilierbare Version für den Standard-OpenAPI-Generator in Version 5.x anbieten kann.

acodingsquirrel commented 3 years ago

Hallo flaxoiu,

bei der API haben wir uns an https://editor.swagger.io/ orientiert. Laut der Definition ist die API mit und ohne Einrückung gültig.

Der Generator, den wir von unserer Seite einsetzen, kommt mit den Einrückungen zurecht. Wir verwenden: swagger-codegen-maven-plugin.version 3.0.18. groupId: io.swagger.codegen.v3 artifactId: swagger-codegen-maven-plugin

Falls es bei dir mit der yaml nicht funktioniert, könntest du auch versuchen die json zu verwenden.

Wir unterstützen nicht, die verwendeten API-Generatoren.