前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >gin集成swagger构建api文档

gin集成swagger构建api文档

作者头像
孤烟
发布2020-09-27 11:10:52
9820
发布2020-09-27 11:10:52
举报
文章被收录于专栏:golang开发笔记golang开发笔记

官方文档

具体步骤如下:

安装 swag
代码语言:javascript
复制
go get github.com/swaggo/swag/cmd/swag

安装gin-swagger

代码语言:javascript
复制
go get -u github.com/swaggo/gin-swagger

go get -u github.com/swaggo/gin-swagger/swaggerFiles
示例 main.go
代码语言:javascript
复制
package main

import (
    _ "demo/docs"
    "github.com/gin-gonic/gin"
    "github.com/swaggo/gin-swagger"
    "github.com/swaggo/gin-swagger/swaggerFiles"
    "net/http"
)

func main() {

    r := gin.Default()
    r.POST("/login", login)
    r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
    r.Run(":8282")
}


// @登录
// @Description login
// @Accept  json
// @Produce json
// @Param   username     path    string     true        "username"
// @Param   passwd     path    string     true        "passwd"
// @Success 200 {string} string    "ok"
// @Router /login [post]
func login(c *gin.Context){
    username := c.PostForm("username")
    passwd := c.PostForm("passwd")
    c.String(http.StatusOK, "Hello world "+username+"_"+passwd)
}
生成文档

在项目目录执行

代码语言:javascript
复制
swag init

这个时候你会发现在项目目录新建了一个docs目录,包含docs.go、swagger.json、swagger.yaml

运行示例程序

go run main.go

查看接口文档

进入 http://127.0.0.1:8282/swagger/index.html

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 官方文档
  • 具体步骤如下:
    • 安装 swag
      • 示例 main.go
        • 生成文档
          • 运行示例程序
            • 查看接口文档
            领券
            问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档