- 安装Swaggo
首先需要安装Swaggo,可以使用以下命令进行安装:
go get -u github.com/swaggo/swag/cmd/swag
- 初始化Swaggo
在项目根目录下执行以下命令,初始化Swaggo:
swag init
执行完毕后,将会在项目根目录下生成docs目录和docs/swagger.json文件。
- 添加注解
在API接口方法的注释中添加注解,示例如下:
// @Summary 获取用户信息
// @Description 根据用户ID获取用户信息
// @Tags 用户信息
// @Accept json
// @Produce json
// @Param id path int true "用户ID"
// @Success 200 {object} UserResponse
// @Router /user/{id} [get]
func GetUser(ctx *gin.Context) {
// 处理逻辑
}
括请求方法、请求路径等。
- 生成文档
在项目根目录下执行以下命令,生成API接口文档:
swag init -g main.go
执行完毕后,将会在docs目录下生成swagger.json和index.html文件。打开index.html文件即可查看API接口文档。
以上就是Swaggo注解的详细使用示例,希望对你有所帮助!如果你想了解更多Swaggo的用法,可以参考Swaggo官方文档。