使用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

此外，请随时检查Blog Post。