golang-swagger安装步骤

原创已于 2023-04-12 11:13:45 修改 · 1.4k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#golang #java

于 2023-03-23 22:56:38 首次发布

文章介绍了如何在Go语言中利用Gin框架和Swag工具来构建SwaggerAPI文档。首先，详细说明了Swag和Gin-Swagger的安装步骤，然后展示了如何编写main函数和控制器以定义API接口。最后提到了初始化Swag和解决访问文档时可能出现的问题。

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

一、下载swagger

安装swag
1. https://github.com/swaggo/swag/releases/ 安装包
2. chmod +x ./swag
3. mv swag /usr/local/bin
4. swag cli：go install github.com/swaggo/swag/cmd/swag@latest
安装gin-swagger
1. go get github.com/swaggo/gin-swagger
安装swaggerfiles
1. go get github.com/swaggo/gin-swagger/swaggerFiles

二、代码编写

main()函数

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

// @title golang api 框架
// @version 1.0
// @contact.name   API Support
// @contact.url    http://www.swagger.io/support
// @contact.email  support@swagger.io

// @host                 localhost:8080
// @BasePath             /
// @query.collection.format   multi
func main() {
        engine := gin.Default()
        engine.GET("/swagger/*any",ginSwagger.WrapHandler(swaggerFiles.Handler))     
        testGroup := engine.Group("/test")
        {
                testGroup.GET("/hello", HelloWorld)
        }

        engine.Run("8080")
}

controller

// List godoc
// @Summary      测试helloworld
// @Description  测试helloworld
// @Tags         测试
// @Accept       json
// @Produce      json
// @Param        name  query     string      true  "姓名"
// @Success      200    {string} json "{"msg":"","code":200}"
// @Failure      400    {string} json "{"msg":"","code":400}"
// @Router       /test/hello [get]
func HelloWorld(ctx *gin.Context) {
        ctx.Json(http.StatusOK, gin.H{"msg":"hello world", "code":200})
}

三、初始化

如果main.go在根目录
1. swag init
如果main.go 函数不在根目录，例如：inter/main.go
1. swag init -g ./inter/main.go
会在根目录生成：docs/ 目录
访问方式
1. http://127.0.0.1:8080/docs/index.html

四、问题描述

访问的时候可能会报出：
1. Fetch errorInternal Server Error doc.json
需要引入 docs目录才行

import (

"github.com/gin-gonic/gin" ginSwagger

"github.com/swaggo/gin-swagger"

"github.com/swaggo/gin-swagger/swaggerFiles"

_ "gin-admin/docs"

)