Swagger API Dokumentation zu groß für Browser / Browser stürzt ab

Shopware 6 (German)
1

Hallo,

inzwischen ist die Arbeit bei uns mit der Shopware API etwas kryptisch geworden. Wir holen ins über die Browser Console / Inspektor immer einen CURL, den wir im REST-Tool „analysieren“ :slight_smile:

Die Swagger HTML-Datei lässt sich zwar erstellen und öffnen, bisher habe ich aber keinen Browser gefunden - der das überlebt. Und selbst auf meiner Workstation mit 64GB RAM lässt es sich weder in Google Chrome, Safari oder Edge öffnen. Bzw. hängt es sich einfach auf…

Habt ihr einen Tipp, wie ich mir die Dokumentation ansehen kann?

2

Ich bin eben mal ein paar Optionen durchgegangen, die keine Swagger HTML erzeugen.

Lösung: Einfach einen HTML-Generator nehmen, der etwas weniger schick ist. Aber dafür reines HTML ausgibt. Das verkraftet auch mein Browser.

Siehe: Documentation for the html Generator | OpenAPI Generator

Bei mir ging das innerhalb von einer Minute:

brew install openapi-generator
openapi-generator generate -i www.localhost.local/api/_info/openapi3.json -g html -o ./dist/apidoc/
1 „Gefällt mir“