gin集成Swagger

gin集成Swagger

1、首先安装 swag 命令行工具:

bash 复制代码
go install github.com/swaggo/swag/cmd/swag@latest

2、添加 Swagger 相关依赖到项目:

bash 复制代码
go get -u github.com/swaggo/swag/cmd/swag
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/files

3、在 main.go 中添加基础配置:

bash 复制代码
package main

import (
    _ "xxx-api/docs"  // 这里会引入即将自动生成的 docs 包
)

// @title           xxx API
// @version         1.0
// @description     xxx统 API 服务
// @termsOfService  http://swagger.io/terms/

// @contact.name   API Support
// @contact.url    http://www.swagger.io/support
// @contact.email  [email protected]

// @license.name  Apache 2.0
// @license.url   http://www.apache.org/licenses/LICENSE-2.0.html

// @host      localhost:8080
// @BasePath  /api

// @securityDefinitions.apikey ApiKeyAuth
// @in header
// @name Authorization
func main() {
    // ... 现有代码 ...
}

4、修改 routers/router.go,添加 Swagger 路由:

bash 复制代码
package routers

import (
    "github.com/gin-gonic/gin"
    swaggerFiles "github.com/swaggo/files"
    ginSwagger "github.com/swaggo/gin-swagger"
)

func InitRouter(engine *gin.Engine) {
    // ... 现有代码 ...

    // Swagger API 文档
    // 仅在开发环境启用
    if gin.Mode() != gin.ReleaseMode {
        engine.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
    }
}

5、创建一个初始化 Swagger 的脚本 scripts/swagger.sh:

bash 复制代码
#!/bin/bash

# 生成 swagger 文档
swag init

# 如果文档生成成功,打印访问地址
if [ $? -eq 0 ]; then
    echo "Swagger 文档生成成功!"
    echo "请访问: http://localhost:8080/swagger/index.html"
else
    echo "Swagger 文档生成失败!"
fi
相关推荐
pedestrian_h1 天前
gin框架学习笔记
笔记·学习·go·web·gin
19岁开始学习1 天前
Gin框架
gin
唐僧洗头爱飘柔95272 天前
(Go Gin)上手Go Gin 基于Go语言开发的Web框架,本文介绍了各种路由的配置信息;包含各场景下请求参数的基本传入接收
后端·golang·go·restful·gin·goweb开发
一个热爱生活的普通人4 天前
GIN 服务如何实现优雅停机
go·gin
chxii5 天前
3.1goweb框架gin下
gin
Delphi菜鸟7 天前
go+mysql+cocos实现游戏搭建
mysql·游戏·golang·gin·cocos2d
老朋友此林10 天前
go语言学习笔记:gin + gorm + mysql 用户增删改查案例入门
mysql·golang·gin
梦兮林夕12 天前
06 文件上传从入门到实战:基于Gin的服务端实现(一)
后端·go·gin
能来帮帮蒟蒻吗25 天前
GO语言学习(16)Gin后端框架
开发语言·笔记·学习·golang·gin
Json201131525 天前
Gin、Echo 和 Beego三个 Go 语言 Web 框架的核心区别及各自的优缺点分析,结合其设计目标、功能特性与适用场景
前端·golang·gin·beego