如何在 go gin-gonic 中创建 swagger.json

Question

我正在尝试将文档添加到使用 gin-gonic 创建的 golang 项目中。我目前面临的问题是 gin-gonic 的稳定版不支持 swagger。

Issue in gin-gonic

目前，当我尝试生成 swagger.json 时，它的路径是空的。 golang 中有没有办法告诉它手动添加端点？

go generate
cat swagger.json 
{
  "swagger": "2.0",
  "paths": {},
  "definitions": {}
}

如果这不是一个选项，我是否应该研究一个不同的框架？

Answer 1

Gin 使用 goswagger 作为基础。你可以试试goswagger directly

按照说明和规定的 godoc 评论规则，您应该会得到与 gin 类似的行为。

仅供参考，我自己没有使用过 goswagger。