配套使用swagger

配套使用swagger

安装

# 获取
go get -u github.com/swaggo/swag/cmd/swag
# 初始化
swag init
# 执行之后会生成docs目录

配置

package router

import (
    v1 "gin-blog/api/v1"
    _ "gin-blog/docs"
    "gin-blog/utils"
    "github.com/gin-gonic/gin"
    "github.com/swaggo/gin-swagger"
    "github.com/swaggo/gin-swagger/swaggerFiles"
)

func InitRouter() { //大写对外暴露 小写私有
    gin.SetMode(utils.AppMode)

    r := gin.Default() //default 默认开启2个中间件 如日志 等

    router := r.Group("api/v1") //api接口组
    {
        //v1.GET("hello", func(context *gin.Context) {
        //    context.JSON(http.StatusOK, gin.H{
        //        "code": 0,
        //        "msg":  "ok",
        //    })
        //})

        // 用户模块
        //router.POST("user/add", v1.AddUser)
        //router.GET("users", v1.GetUsers)
        //router.PUT("user/:id", v1.EditUser)
        //router.DELETE("user/:id", v1.DeleteUser)
        router.POST("wx/login", v1.WechatLogin)
        router.POST("wx/update",v1.WechatUpdate)
    }

    //绑定新的解析地址
    r.GET("/swagger/*any",ginSwagger.WrapHandler(swaggerFiles.Handler))


    err := r.Run(utils.HttpPort)
    if err != nil {
        return
    }
}

访问

由于我开发使用的是 8888 端口，所以访问地址是： http://127.0.0.1:8888/swagger/index.html