Gin框架中配置Swagger(完整流程版)
package main
import (
"github.com/gin-gonic/gin"
"github.com/swaggo/gin-swagger"
"github.com/swaggo/gin-swagger/swaggerFiles"
)
// @title Swagger Example API
// @version 1.0
// @description This is a sample server Petstore server.
// @termsOfService http://swagger.io/terms/
// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @host petstore.swagger.io
// @BasePath /v1
func main() {
r := gin.New()
// 为 gin framewrok 加入 swagger 文档支持
// 使用 go-swagger 自动生成中间件
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
// 你的 API 路由定义
// ...
// 启动服务器
r.Run() // 默认在0.0.0.0:8080
}
这段代码演示了如何在Gin框架中集成Swagger,并启动一个带有Swagger文档支持的API服务器。这是一个简化版本的代码,它省略了具体的API路由定义,只包含了Swagger集成和服务器启动的关键部分。在实际应用中,你需要将其与你的API路由定义配置相结合。
评论已关闭