使用golang注释生成Swagger规范

Question

我正在尝试使用Swagger为golang编写的REST API创建文档.我一直在遵循这个指南:https://goswagger.io/generate/spec.html这样做,并且能够从我的主文件中的注释创建json文件,但是我不知道如何创建. yaml文件将转换为实际的swagger规范.我已按照页面上的说明进行操作,并将其包含//go:generate swagger generate spec在我的主文件中.有谁知道如何创建.yaml文件？

Answer 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