简述 Gin 框架如何集成swagger

最新推荐文章于 2025-07-01 18:56:52 发布

jinjiangcc

最新推荐文章于 2025-07-01 18:56:52 发布

阅读量8k

点赞数 2

CC 4.0 BY-SA版权

分类专栏： golang 文章标签： golang gin swagger

本文链接：https://blog.youkuaiyun.com/raogeeg/article/details/86743953

本文档详细介绍了如何在Gin框架中集成Swagger，包括安装Swagger工具，添加依赖包，编写示例程序，并手动指定路由以生成API文档，最后通过执行命令展示Swagger UI。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

简述Gin框架集成swagger过程

1、安装 `swag`

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

swag 用于生成 docs 文件夹(swagger文档程序使用)

安装完成后会在 ${GOPATH}/bin生成一个执行文件

2、安装依赖包

github.com/gin-gonic/gin
github.com/swaggo/gin-swagger

3、示例程序


/**
 * Created by martin on 01/02/2019
 */

package main

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

// @title 测试
// @version 0.0.1
// @description  测试
// @BasePath /api/v1/
func main() {
	r := gin.New()

	// 创建路由组
	v1 := r.Group("/api/v1")

	v1.GET("/record/:userId",record)

	// 文档界面访问URL
	// http://127.0.0.1:8080/swagger/index.html
	r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

	r.Run()
}

// @获取指定ID记录
// @Descriptio