Generieren Swagger-Spezifikation mit Golang-Kommentaren

Question

Ich versuche, Dokumentation für meine REST API in Golang mit Swagger geschrieben erstellen. Ich habe diesen Leitfaden: https://goswagger.io/generate/spec.html zu tun und in der Lage, die JSON-Datei aus meinen Kommentaren in meiner Hauptdatei zu erstellen, aber ich weiß nicht, wie Sie die .Yaml-Datei erstellen, die in die eigentliche Swagger-Spezifikation übersetzen würde. Ich habe die Anweisungen auf der Seite befolgt und die //go:generate swagger generate spec in meine Hauptdatei aufgenommen. Kann jemand die .yaml-Datei erstellen?

Answer 1

Die generierte Spezifikation würde zu diesem Zeitpunkt Json nicht Yaml sein, nicht sagen, es kann nicht gemacht werden Yam zu tun, aber derzeit generiert es nur Json. //go:generate swagger generate spec -o swagger.json

dann können Sie die Spezifikation erzeugen mit:

Sie können Ihr Hauptpaket mit Anmerkungen versehen go generate, wenn Sie in Ordner des Hauptpaketes sind. Wenn Ihr Hauptpaket nicht Ihr Projektstamm ist, sondern etwas wie $project_root/cmd/my-server, dann können Sie go generate ./cmd/my-server aus dem Projektstamm ausführen.