当前位置: 代码网 > it编程>前端脚本>Golang > golang使用swagger的过程详解

golang使用swagger的过程详解

2024年06月13日 Golang 我要评论
1、安装go install github.com/swaggo/swag/cmd/swag@latestgo get -u github.com/swaggo/gin-swaggergo get -

1、安装

go install github.com/swaggo/swag/cmd/swag@latest
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/gin-swagger/swaggerfiles

2、生成swag文档

命令:swag init

错误
'swag' 不是内部或外部命令,也不是可运行的程序
或批处理文件。
 go install github.com/swaggo/swag/cmd/swag@latest

需要安装到bin环境变量

3、在main上添加

// @title swagger example api
// @version 1.0.0
// @description this is a sample server pets
// @securitydefinitions.apikey apikeyauth
// @in header
// @name x-token
// @basepath /
func main() {

4、 引入docs文档

报错 fetch error internal server error doc.json 是没有引入docs

5、创建swagger路由

engine.get("/swagger/*any", ginswagger.wraphandler(swaggerfiles.handler))

 6、再接口上添加注释

// @tags checkapi
// @summary 检测测试
// @accept application/json
// @produce application/json
// @param data query request.req true "查询渠道"
// @success 200 {string} string "{"success":true,"data":{},"msg":"查询成功"}"
// @router /router/addr [get]

6、success 

到此这篇关于golang使用swagger的文章就介绍到这了,更多相关golang使用swagger内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网!

(0)

相关文章:

版权声明:本文内容由互联网用户贡献,该文观点仅代表作者本人。本站仅提供信息存储服务,不拥有所有权,不承担相关法律责任。 如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 2386932994@qq.com 举报,一经查实将立刻删除。

发表评论

验证码:
Copyright © 2017-2025  代码网 保留所有权利. 粤ICP备2024248653号
站长QQ:2386932994 | 联系邮箱:2386932994@qq.com