Fehlerhafte OpenAPI-Spezifikation in Shopware v.6.3.3.1 Community Edition

Shopware 6 (German) Programmierung
1

Hallo zusammen,

mein Ziel ist es, aus C# heraus auf die Shopware Admin API zuzugreifen. Hierzu habe ich mir über das Tool NSwagStudio aus der OpenAPI-Spezifikation (api/v3/_info/openapi3.json) und den Content Type “application/json” die notwenigen C# Klassen erstellen lassen. Hierbei fiel mir auf, dass es innerhalb der OpenAPI-Spezifikation offenbar ein paar Fehler gibt. Dazu ein paar Beispiele:

  • Bei der Datenstruktur “product_flat” ist für die Eigenschaft “price” keine Typreferenz auf eine Preisdatenstruktur sondern nur “object” hinterlegt
  • Bei der Datenstruktur “product_flat” ist für die Eigenschaft “configuratorGroupConfig” keine Typreferenz auf die entsprechende Datenstruktur sondern nur “object” hinterlegt
  • Sämtliche Beziehungen zu anderen Typen in “product_flat” sind 1 zu 1 (auch Sichtbarkeiten, Optionen, Eigenschaften, Medien, Regelpreise etc.)
  • In “product_flat” ist auch “createdAt” als obligatorisch markiert, obwohl es keine Fehlermeldung gibt, wenn ich dieses nicht an die API übergebe

Das waren bei weitem nicht alle Fehler. Wäre es möglich, die OpenAPI-Spezifikation zu korrigieren?

1 „Gefällt mir“
2

Hier das Gleiche. Wir würden ebenfalls gerne via OpenAPI Generator oder NSwag funktionierende Clients erstellen lassen. Aber durch defekte Referenzen und fehlende Search-Endpunkte geht dies nicht ohne weiteres. Weiterhin sind immer noch Fehler bei verschiedenen Referenzen und bei der Rückgabe von einzelnen Objekten (z. B. /order/{id}) wird nicht gleich das Order Objekt sondern erst ein Data-Objekt geliefert

„data“: {}

Mit der OpenAPI Spec kann man so keinen funktionsfäigen Client erzeugen lassen. Sehr schade :unamused: