gin swag 安装&使用手册&问题

最新推荐文章于 2025-06-06 23:20:55 发布

竹昊

最新推荐文章于 2025-06-06 23:20:55 发布

阅读量2.3k

点赞数

CC 4.0 BY-SA版权

分类专栏：项目搭建&环境配置文章标签： golang swagger2 http

本文链接：https://blog.csdn.net/qq_39522569/article/details/117753547

项目搭建&环境配置专栏收录该内容

3 篇文章

订阅专栏

本文档详细介绍了gin-swagger的安装步骤与使用方法，并提供了示例代码帮助开发者快速搭建带有文档功能的RESTful API服务。同时，针对安装及运行过程中可能遇到的问题给出了相应的解决策略。

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

gin-swagger 安装&使用手册&问题

官方地址

https://github.com/swaggo/gin-swagger

安装教程

#!/bin/bash
# install swag
go get -u github.com/swaggo/swag/cmd/swag

#Download gin-swagger by using:
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/files

init

swag init

特别提醒

swag 之后会默认生成docs目录，请在项目中导入

import _ "Your/Project/RootPath/docs"

API信息

官方文档： https://swaggo.github.io/swaggo.io/declarative_comments_format/

快速上手

gin-swagger

import （
	_ "Your/Project/RootPath/docs"
	"github.com/gin-gonic/gin"
	ginSwagger "github.com/swaggo/gin-swagger"
	"github.com/swaggo/gin-swagger/swaggerFiles"
）
// @title ioc api
// @version v0.0.1
// @description null
// @termsOfService http://swagger.io/terms/
// @contact.name puhao
// @contact.url puhao
// @contact.email puhao
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @host 0.0.0.0:8989
// @BasePath
func main() {

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

API Info

// Login godoc
// @Summary login with user and password, get token
// @Tags login
// @version 1.0
// @Accept application/x-json-stream
// @Param user query string true "user name"
// @Param pd query string true "user's password"
// @Router /openapi/login [get]
// @Success 200 {object} YOURObject "{"code":200,"data": {"token": ""},"msg":""}"
// @Failure 403 {object} YOURObject {"code":200,"data":null,"msg":""}
func Login(c *gin.Context) {
   //...Your logic

}