使用 golang 注释生成 Swagger 规范

Question

我正在尝试使用 Swagger 为我用 golang 编写的 REST API 创建文档。我一直在遵循本指南：https ://goswagger.io/generate/spec.html这样做，并且能够从我的主文件中的评论创建 json 文件，但是我不知道如何创建 . yaml 文件，该文件将转换为实际的招摇规范。我已按照页面上的说明进行操作，并将其包含//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从项目根目录运行。

Answer 2

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

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

另外，请随时查看博客文章。