title: Go语言gin框架通过swagger生成API接口文档说明-附项目地址
date: 2023-06-29 15:04:26.0
updated: 2023-06-29 15:04:26.0
url: https://liumou.site/doc/646
categories:

开发
GO
后端
Gin
tags:

安装

命令行工具安装

首先执行下面的命令进行swag命令的安装

go install github.com/swaggo/swag/cmd/swag@latest

安装命令可以在任意工作目录执行

初始化

首先进入项目根目录，然后执行下面的命令生产接口说明模块

swag init

效果如下

PS C:\Users\X\GolandProjects\Demo> swag init
2023/06/29 11:29:06 Generate swagger docs....
2023/06/29 11:29:06 Generate general API Info, search dir:./
2023/06/29 11:29:08 create docs.go at docs/docs.go
2023/06/29 11:29:08 create swagger.json at docs/swagger.json
2023/06/29 11:29:08 create swagger.yaml at docs/swagger.yaml
PS C:\Users\X\GolandProjects\Demo>