Skip to content

生成swagger自动化API文档

注意

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 版本 是 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 文档

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

Copyright © 2020-2022 Flipped-aurora Open Source Community