使用 golang 注释生成 Swagger 规范

Question

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

Answer 1

现阶段生成的 spec 是 json 而不是 yaml，不是说不能做 yaml 但目前它只生成 json.

您可以用以下方式注释您的主包：//go:generate swagger generate spec -o swagger.json

然后你可以生成规范： go generate 当你在主包的文件夹中时。如果您的主包不是您的项目根目录而是类似 $project_root/cmd/my-server 的东西，那么您可以从项目根目录 运行 go generate ./cmd/my-server。

Answer 2

是的，您可以创建 YAML 文件。举个例子。

swagger generate spec -m -o ../../api/swagger.yaml

此外，请随时查看 Blog Post。