网站首页 返回列表像“草根”一样，紧贴着地面，低调的存在，冬去春来，枯荣无恙。

gin集成 swagger

2020-06-10 02:42:53 admin 1014

[文档](https://links.jianshu.com/go?to=https%3A%2F%2Fswaggo.github.io%2Fswaggo.io%2Fdeclarative_comments_format%2Fapi_operation.html)

# 安装

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

转载文章，原文链接： gin集成 swagger

关键字词Gin swagger

分享到：

上一篇：我练习口语的经验与方法

下一篇：go平滑重启调研选型和项目实践

如需留言，请登录，没有账号？请注册

0 条评论 0 人参与

网站首页 返回列表像“草根”一样，紧贴着地面，低调的存在，冬去春来，枯荣无恙。

gin集成 swagger

zhou 3年前

zhou 3年前

zhou 3年前

zhou 3年前

武云 3年前

网站首页 返回列表 像“草根”一样，紧贴着地面，低调的存在，冬去春来，枯荣无恙。

gin集成 swagger

zhou 3年前

zhou 3年前

zhou 3年前

zhou 3年前

武云 3年前

网站首页返回列表像“草根”一样，紧贴着地面，低调的存在，冬去春来，枯荣无恙。