文档

安装

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

等待安装完成，

初始化

终端中执行

swag init

基于应用根目录，与启动文件同一级。执行完成后，在根目录下新建一个 docs 文件夹。

目录结构

.
├── docs.go
├── swagger.json
└── swagger.yaml

路由引入

router 中的 引入(import代码段)

swaggerFiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"

应用集成

router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

添加文档注释

示例1

// @description 通过id获取用户
// @version 1.0
// @accept application/x-json-stream
// @param id path int true "id"
// @router /user/{id} [get]
func UserGet(ctx *gin.Context) {
    //...
}

示例2

package main

import (
    _ "bingo_service/docs"
)

//...

// @title gin 框架
// @version 1.0
// @description 给予gin web框架搭建的业务骨架
// @termsofservice http://swagger.io/terms/
// @contact.name jinchunguang
// @contact.email jin-chunguang@foxmail.com
// @host localhost:10010
func main() {
    //...
}

等等

重新执行 swag init，更新配置文件

查看效果

image.png