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
相关推荐
Json20113154 小时前
Gin、Echo 和 Beego三个 Go 语言 Web 框架的核心区别及各自的优缺点分析,结合其设计目标、功能特性与适用场景
前端·golang·gin·beego
Json20113151 天前
Swoole 的 Hyperf 框架和 Go 的 Gin 框架高并发原理以及技术实现对比分析
网络·php·gin·swoole
赴前尘1 天前
Go+Gin实现安全多文件上传:带MD5校验的完整解决方案
安全·golang·gin
Golinie1 天前
Ollama+Langchaingo+Gin开发本地LLM简单应用
大模型·gin·ollama·langchaingo
yuanlaile2 天前
Gin介绍及Gin环境搭建
golang·gin·gin环境搭建
techdashen2 天前
性能比拼: Go(Gin) vs Python(Flask)
python·golang·gin
Golinie3 天前
使用Ollama+Langchaingo+Gin通过定义prompt模版实现翻译功能
llm·prompt·gin·langchaingo
南屿欣风5 天前
解决 Gin Web 应用中 Air 热部署无效的问题
前端·gin
执念斩长河6 天前
gin学习
驱动开发·学习·gin
forestsea6 天前
PostgreSQL: GIN 索引详解
数据库·postgresql·gin