golang+swagger+mux配置

最新推荐文章于 2025-03-27 11:00:28 发布

daiqinge

最新推荐文章于 2025-03-27 11:00:28 发布

阅读量1.5k

点赞数

分类专栏： golang 文章标签： golang swagger mux

本文链接：https://blog.youkuaiyun.com/daiqinge/article/details/107172783

版权

这篇博客介绍了如何在Golang项目中集成Swagger和Mux。首先，通过安装相关工具来开始。然后，在`main.go`中导入必要的包。接着，使用注解在代码中添加Swagger文档，运行`swag init`命令生成doc.json。最后，博主分享了其他一些Golang命令，如初始化模块、构建项目和管理依赖。

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

1. install and import swagger

参考https://www.soberkoder.com/swagger-go-api-swaggo/

step 1:

install swagger related tool:

go get -u github.com/swaggo/swag/cmd/swag
go get -u github.com/swaggo/http-swagger
go get -u github.com/alecthomas/template

step 2:

in main.go, import related package:

_ "xxx/docs" // this xxx name your real golang project package name, from "go mod init xxx" command  
httpSwagger "github.com/swaggo/http-swagger"
"github.com/gorilla/mux" 
"bytes"
"net/url"
"github.com/tidwall/gjson"
"encoding/base64"
"fmt"
"encoding/json"

2. golang code and swagger annotation

step 1, add following annotation before main() function or your related function. if before your non-main function, you need to add security related configuration in your doc.json file after "swag init" command

const (
	TokenURL = "https://xxxxx.com/v1/user/token"
)

// @title appstatusviewer
// @version 1.0
// @description appstatusviewer swagger
// @termsOfService http://swagger.io/terms/
// @contact.name API Support
// @contact.email xx@gmail.com
//