Создание спецификации Swagger с комментариями golang

Question

Я пытаюсь создать документацию для моего REST API, написанную в golang, используя Swagger. Я следую этому руководству: https://goswagger.io/generate/spec.html, чтобы сделать это, и мне удалось создать json-файл из моих комментариев в моем основном файле, однако я не знаю, как создать файл .yaml, который переводится в фактическую спецификацию swagger. Я выполнил инструкции на странице и включил //go:generate swagger generate spec в свой основной файл. Кто-нибудь знает, как создать файл .yaml?

Answer 1

Сгенерированная спецификация была бы json not yaml на этом этапе, не говоря о том, что нельзя сделать yaml, но в настоящее время она генерирует только json.

вы можете аннотировать основной пакет с: //go:generate swagger generate spec -o swagger.json

, то вы можете создать спецификацию с: go generate, когда вы находитесь в папке основного пакета. Если ваш основной пакет не является вашим корнем проекта, но что-то вроде $project_root/cmd/my-server, вы можете запустить go generate ./cmd/my-server из корня проекта.