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

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

7
go swagger swagger-2.0

1 ответов

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

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

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

3