首页 文章

使用golang注释生成Swagger规范

提问于
浏览
7

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

1 回答

  • 3

    在这个阶段生成的规范将是json而不是yaml,并不是说它不能成为yaml但是目前它只生成json .

    您可以使用以下命令注释主包: //go:generate swagger generate spec -o swagger.json

    然后,当您在主包的文件夹中时,您可以使用: go generate 生成规范 . 如果您的主程序包不是您的项目根目录但是像 $project_root/cmd/my-server 那样,那么您可以从项目根目录运行 go generate ./cmd/my-server .

相关问题