下载swag

  1. go get -u github.com/swaggo/swag/cmd/swag

初始化

在包含main.go文件的项目根目录运行swag init。这将会解析注释并生成需要的文件(docs文件夹和docs/docs.go)。

  1. swag init

确保导入了生成的docs/docs.go文件,这样特定的配置文件才会被初始化。如果通用API指数没有写在main.go中,可以使用-g标识符来告知swag。

  1. swag init -g http/api.go

参考

https://github.com/swaggo/swag/blob/master/README_zh-CN.md
https://github.com/razeencheng/demo-go