返回介绍

Swagger

发布于 2024-08-12 12:46:24 字数 2637 浏览 0 评论 0 收藏 0

注意

version 对应 gin-vue-admin/server/go.mod 的swag库的版本,如github.com/swaggo/swag v1.7.0,则version的值为 v1.7.0 如果想要使用最新版的swag,version的值为latest,在server目录下执行以下命令会自动更新 server/go.mod 中的swag库版本为最新版,如果更新则需要手动把gin-vue-admin/server/go.mod的 github.com/swaggo/swag 最新版版本号

1 安装 swagger

  • 可以翻墙

    go install github.com/swaggo/swag/cmd/swag@version
    
  • 无法翻墙 由于国内没法安装 go.org/x 包下面的东西,推荐使用 goproxy.cn 或者 goproxy.cn/

# Go 版本 是 1.16 ~ 最新版 可以忽略以下步骤一
# 步骤一、启用 Go Modules 功能
go env -w GO111MODULE=on 
# 步骤二、配置 GOPROXY 环境变量
go env -w GOPROXY=https://goproxy.cn,direct

# 使用如下命令下载swag
go install github.com/swaggo/swag/cmd/swag@version

2 生成API文档

cd server
swag init

执行上面的命令后,server目录下会出现docs文件夹,打开浏览器复制如下地址,即可查看swagger文档

http://localhost:8888/swagger/index.html

3 swagger 文档

遇到问题请认真观看文档地址

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文