Generazione di specifiche Swagger con commenti golang

Question

Sto cercando di creare documentazione per la mia API REST scritta in golang utilizzando Swagger. Ho seguito questa guida: https://goswagger.io/generate/spec.html per farlo e sono stato in grado di creare il file JSON dai miei commenti nel mio file principale, tuttavia non so come creare il file .yaml che si tradurrebbe nella specifica swagger effettiva. Ho seguito le istruzioni sulla pagina e incluso lo //go:generate swagger generate spec nel mio file principale. Qualcuno sa come creare il file .yaml?

Answer 1

La specifica generata sarebbe json not yaml in questa fase, non dicendo che non può essere fatta per fare yaml ma attualmente genera solo json.

è possibile annotare il pacchetto principale con: //go:generate swagger generate spec -o swagger.json

allora è possibile generare la specifica con: go generate quando ci si trova nella cartella del pacchetto principale. Se il tuo pacchetto principale non è la root del progetto ma qualcosa come $project_root/cmd/my-server allora puoi eseguire go generate ./cmd/my-server dalla root del progetto.