• 欢迎来到本博客,希望可以y一起学习与分享

go swagger 文档

笔记 benz 2周前 (09-03) 4次浏览 0个评论 扫描二维码

作为一个后端开发,给前端提供api接口是必须的。手动去写文档不是一个程序员的风格。swagger就是一个很好的api文档生成该工具,go当然也支持了。下面看看怎么使用这个工具。

1、安装需要用到的包

安装完成后检查命令是否可用,如果不行执行,请将$GOPATH/bin 加入到 $PATH当中去。在windows中可以在下载源码后,自己编译生成swag.exe程序。后续把exe文件拷贝到项目根目录下面执行swag.exe, init也是一样的。

安装以下两个包

执行初始化命令

初始化命令,在根目录生成一个docs文件夹

docs/docs.go
在路由上添加一个swagger访问地址

写注释

再次执行初始化命令

访问:http://ip:port/doc/index.html

注意事项
1、假如func方法头标注的swagger注释不正确,在执行swag init会报错,自行根据报错信息去修改;
2、访问swagger控制台报错404 page not found,是因为没有添加swagger的路由:router.GET("/swagger/*any",ginSwagger.WrapHandler(swaggerFiles.Handler, url));
3、访问swagger控制台报错Failed to load spec,是因为没有import引入执行swag init生成的swagger的docs文件夹;

附上Swagger的注解


文章 go swagger 文档 转载需要注明出处
喜欢 (0)

您必须 登录 才能发表评论!