身为一位后端程序员,后端api文档的编写是必要的,我们可以使用swag的自动生成来实现api文档的自动生成

环境配置

我使用的环境是macos和golang

要使用swaggo,首先要下载一个swag命令行。

go get github.com/swaggo/swag/cmd/swag

我们可以使用命令

ll -r $GOPATH/bin

或者直接进入目录查看我们的bin目录下多了一个swag命令文件

在这里插入图片描述

我们还需要编辑mac的环境变量才能在命令行里面使用swag命令

使用vim编辑器编辑macos的环境变量参数文件

vim .bash_profile

在该文件后追加一行

export PATH=$GO_PATH/bin/:$PATH

然后使用命令

source ~/.bash_profile

更新环境变量

配置环境变量结束之后就可以在命令行里面使用swag了

我们进入我们的gin项目

编写对应的doc参数

在这里插入图片描述

使用swag init后把程序run起来就可以进入查看我们生成的api文档了

swag init
go run main.go

在这里插入图片描述