go-iris Swagger Api搭建

最新推荐文章于 2025-01-19 09:13:56 发布

原创最新推荐文章于 2025-01-19 09:13:56 发布 · 706 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#go swagger

golang 专栏收录该内容

8 篇文章

订阅专栏

本文介绍了如何通过安装Swaggo，更新go.mod依赖，以及在Go项目中集成Swagger，生成RESTful API的文档。步骤包括安装Swaggo、修改配置并执行初始化，最终通过http访问生成的Swagger UI以查看API文档。

1、安装swag

go get -u github.com/swaggo/swag/cmd/swag

swag -version

能显示版本信息则表示安装成功

2、修改go.mod文件信息在require中加入下属代码

github.com/swaggo/swag v1.8.0 // indirect
github.com/iris-contrib/swagger/v12 v12.0.1

3、修改main.go 或者router.go

import (

"github.com/iris-contrib/swagger/v12"

"github.com/iris-contrib/swagger/v12/swaggerFiles"

)

app := iris.New()
app.Logger().SetLevel("debug")
app.Use(recover.New())
app.Use(logger.New())

config := &swagger.Config{
   URL: "http://localhost:8080/swagger/doc.json",
}

app.Get("/swagger/{any:path}", swagger.CustomWrapHandler(config, swaggerFiles.Handler))

在terminal窗口执行swag init 在项目目录下生成docs

go run main.go

打开 http://localhost:8080/swagger/index.html即可看到