安装与初始化
- 安装插件
go install github.com/swaggo/swag/cmd/swag@latest
- 安装依赖
go get -u github.com/swaggo/swag/cmd/swag
- 在包含main.go文件的项目根目录运行
swag init
。这将会解析注释并生成需要的文件(docs文件夹和docs/docs.go)。
swag init
一定要在main.go
的统计目录下,不然会出现如下错误:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/8f60f1411ad6b29ef952c120081ac6b0.png)
切换到main.go统计目录后重新生成:
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/6ed15d7f1253ee798348397aae1517c2.png)
生成了一个docs目录
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/e138495a2279129a251703f3955aa034.png)
![在这里插入图片描述](https://i-blog.csdnimg.cn/blog_migrate/92d1d0de271cd5033a57795638c2f3c2.png)
上述文件是根据swagger的注解生成的,虽然现在还没有swagger的注解