使用 golang 注释生成 Swagger 规范

【问题标题】：Generating Swagger spec with golang comments使用 golang 注释生成 Swagger 规范
【发布时间】：2016-09-30 04:01:21
【问题描述】：

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

【问题讨论】：

你能做到吗？我正在尝试为自己的项目做这件事，但没有运气

标签： go swagger swagger-2.0

【解决方案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。

【讨论】：

【解决方案2】：

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

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

另外，请随时查看Blog Post。

【讨论】：