go - 如何在 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。