gin-swagger

1. 下载 swagger
2. 加载 swagger
3. 执行 swagger命令
4. 使用Cors中间件
5. 测试

1 下载swagger

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

2 安装swagger

安装go-swagger，移动到下载的go-swagger包目录（应该是GOPATH/src/pkg/github.com/go-swagger,理解这个意思就好，路径不一定对）。

go install ./cmd/swagger

测试是否安装成功 cmd 执行 swag -V 反馈 swag 版本

执行后，会生成docs/doc.go以及docs/swagger.json,docs/swagger.yaml

go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/files

2 加载 swagger

package router

import (
    "gin_t/middelwares"
    "gin_t/service"
    "net/http"

    "github.com/gin-gonic/gin"
    swaggerfiles "github.com/swaggo/files"
    ginSwagger "github.com/swaggo/gin-swagger"
)

// @Tags 标签
// @Summary 标题
// @description 描述,可以有多个

// @Success 200 {string} json "{"code":"200","data":"message":"string"}"
// @Router /ping [get]
func Router() *gin.Engine {
    r := gin.Default()
    r.Use(middelwares.Cors())
    r.GET("/ping", func(ctx *gin.Context) {
        ctx.JSON(http.StatusOK, gin.H{
            "message": "pong",
        })
    })
    // Swagger 配置
    r.GET("swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
    return r
}

package service

import (
    "net/http"

    "github.com/gin-gonic/gin"
)

func Ping(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{
        "message": "pong",
    })
}

package main

import (
    _ "gin_t/docs"
    "gin_t/router"
)

// @title API文档
// @version 1.0
// @description API 文档
// @host 127.0.0.01:8080
// @BasePath

func main() {
    
    r := router.Router()

    r.Run()
}

3 执行 swagger命令

cmd 项目执行  swag init  

4 使用Cors中间件

package middelwares

import (
    "fmt"
    "strings"

    "github.com/gin-gonic/gin"
)

func Cors() gin.HandlerFunc {
    return func(c *gin.Context) {
        method := c.Request.Method
        origin := c.Request.Header.Get("Origin")
        var headerKeys []string
        for k, _ := range c.Request.Header {
            headerKeys = append(headerKeys, k)
        }
        headerStr := strings.Join(headerKeys, ", ")
        if headerStr != "" {
            headerStr = fmt.Sprintf("access-control-allow-origin, access-control-allow-headers, %s", headerStr)
        } else {
            headerStr = "access-control-allow-origin, access-control-allow-headers"
        }
        if origin != "" {
            c.Writer.Header().Set("Access-Control-Allow-Origin", "*")
            c.Header("Access-Control-Allow-Origin", "*")                                       // 这是允许访问所有域
            c.Header("Access-Control-Allow-Methods", "POST, GET, OPTIONS, PUT, DELETE,UPDATE") //服务器支持的所有跨域请求的方法,为了避免浏览次请求的多次'预检'请求
            //  header的类型
            c.Header("Access-Control-Allow-Headers", "Authorization, Content-Length, X-CSRF-Token, Token,session,X_Requested_With,Accept, Origin, Host, Connection, Accept-Encoding, Accept-Language,DNT, X-CustomHeader, Keep-Alive, User-Agent, X-Requested-With, If-Modified-Since, Cache-Control, Content-Type, Pragma")
            //              允许跨域设置                                                                                                      可以返回其他子段
            c.Header("Access-Control-Expose-Headers", "Content-Length, Access-Control-Allow-Origin, Access-Control-Allow-Headers,Cache-Control,Content-Language,Content-Type,Expires,Last-Modified,Pragma,FooBar") // 跨域关键设置 让浏览器可以解析
            c.Header("Access-Control-Max-Age", "172800")                                                                                                                                                           // 缓存请求信息 单位为秒
            c.Header("Access-Control-Allow-Credentials", "false")                                                                                                                                                  //  跨域请求是否需要带cookie信息 默认设置为true
            c.Set("content-type", "application/json")                                                                                                                                                              // 设置返回格式是json
        }

        //放行所有OPTIONS方法
        //if method == "OPTIONS" {
        //    c.JSON(http.StatusOK, "Options Request!")
        //}
        if method == "OPTIONS" {
            c.AbortWithStatus(204)
            return
        }
        // 处理请求
        c.Next() //  处理请求
    }
}

5 测试

http://localhost:8080/swagger/index.html

swag注解开发方法

swagger主文件注解-通用API信息

每个API的注释编写-单个api

//各个api.go
// GetProblemList
// @Tags 公共方法
// @Summary 问题列表
// @Param page query int false "page"
// @Param size query int false "size"
// @Param keyword query string false "keyword"
// @Param category_identity query string false "category_identity"
// @Success 200 {string} json "{"code":"200","data":""}"
// @Router /problem-list [get]

//各个api.go
// @Summary 支付列表
// @Description 获取支付列表
// @Accept  json
// @Produce  json
// @param Authorization header string true "验证参数Bearer和token空格拼接"
// @Param  body body st.PaySearch true "交款查询参数"
// @Success 200 {object} response.Response{data=st.PayListResponse}
// @Failure 500 {object} response.Response
// @Router /app/pay/list [post]


//main.go
// @title 这里写标题`
// @version 1.0`
// @description 这里写描述信息`
// @termsOfService [http://swagger.io/terms/](http://swagger.io/terms/)`
// @contact.name 这里写联系人信息`
// @contact.url [http://www.swagger.io/support](http://www.swagger.io/support)`
// @contact.email support@swagger.io`
// @license.name Apache 2.0`
// @license.url [http://www.apache.org/licenses/LICENSE-2.0.html](http://www.apache.org/licenses/LICENSE-2.0.html)`
// @host 这里写接口服务的host`
// @BasePath 这里写base path`


//main.go
// @title API文档
// @version 1.0
// @description API 文档
// @host 127.0.0.01:8080
// @BasePath