Golang使用Swagger文檔教程詳解
Golang開(kāi)發(fā)效率是杠杠滴,簡(jiǎn)單幾行代碼就可完成一個(gè)可用的服務(wù),如下代碼:
- 采用Gin作為web framework
- 采用Gorm作為持久化ORM
- 采用Swagger作為OpenAPI文檔管理工具
package main import ( "encoding/csv" "fmt" "os" "strconv" "time" _ "export/docs" "github.com/gin-gonic/gin" swaggerFiles "github.com/swaggo/files" ginSwagger "github.com/swaggo/gin-swagger" "gorm.io/driver/mysql" "gorm.io/gorm" ) type Detail struct { Id int Name string FirstTime time.Time LastTime time.Time } // @title NeoApi Swagger 標(biāo)題 // @version 1.0 版本 // @description NeoApi Service 描述 // @BasePath /api 基礎(chǔ)路徑 // @query.collection.format multi func main() { r := gin.Default() r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler)) r.GET("/api/export", export) r.POST("/api/data", func(c *gin.Context) { c.JSON(200, gin.H{ "message": "success", }) }) r.Run("0.0.0.0:9527") } // @Summary 導(dǎo)出數(shù)據(jù) // @Description 導(dǎo)出數(shù)據(jù) // @Accept json // @Produce json // @Success 200 string string "success" // @Router /api/export [get] func export(c *gin.Context) { dsn := "dev:123456@tcp(192.168.1.203:33306)/menshen?charset=utf8mb4&parseTime=true" db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{}) if err != nil { panic("failed to connect database") } var persons []uint db.Raw("select id from person").Scan(&persons) fmt.Println(persons) month := 3 monthFile := "08.csv" csvfile, err := os.Create(monthFile) if err != nil { fmt.Println("Error:", err) return } defer csvfile.Close() for _, id := range persons { var data []Detail // 注意 Gorm 字段映射默認(rèn)嚴(yán)格駝峰命名,否則取不到值 db.Raw(`select s.person_id as id, s.person_name as name, min(s.origin_time) as first_time, max(s.origin_time) as last_time from ( select person_id, person_name, origin_time, date_format(origin_time, '%d') as day FROM event_record where person_id=? and primary_type=100 and PERIOD_DIFF(date_format(now( ), '%Y%m'), date_format(origin_time, '%Y%m'))=?) s group by s.day `, id, month).Scan(&data) writer := csv.NewWriter(csvfile) for _, da := range data { record := []string{strconv.Itoa(da.Id), da.Name, da.FirstTime.Format("2006-01-02 15:04:05"), da.LastTime.Format("2006-01-02 15:04:05")} err := writer.Write(record) if err != nil { fmt.Println("Error:", err) return } } writer.Flush() } c.JSON(200, gin.H{ "message": "export success", }) }
簡(jiǎn)單介紹一下Swagger的使用。
首先導(dǎo)入swagger相關(guān)的包
swaggerFiles "github.com/swaggo/files" ginSwagger "github.com/swaggo/gin-swagger" _ "export/docs"
- swaggerFiles和ginSwagger是swaggo庫(kù)提供
- export/docs是swag命令生成的本地API文檔源代碼(export是我的項(xiàng)目名稱),在golang里面只需要docs.go,如下:
其次,想要生成swagger文檔也非常簡(jiǎn)單,
- 安裝swag命令行工具:go get github.com/swaggo/swag/cmd/swag@v1.8.12
- 編寫(xiě)項(xiàng)目的swagger注釋文檔
- 執(zhí)行生成命令:swag init 在項(xiàng)目docs目錄下生成相關(guān)文件
然后,為swagger注冊(cè)gin路由
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
最后,啟動(dòng)服務(wù),訪問(wèn)地址:Swagger UI 即可,如果想查看json格式的文檔,可訪問(wèn)地址:localhost:9527/swagger/doc.json
以上就是Golang使用Swagger文檔教程詳解的詳細(xì)內(nèi)容,更多關(guān)于Golang使用Swagger文檔的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
go-zero使用goctl生成mongodb的操作使用方法
mongodb是一種高性能、開(kāi)源、文檔型的nosql數(shù)據(jù)庫(kù),被廣泛應(yīng)用于web應(yīng)用、大數(shù)據(jù)以及云計(jì)算領(lǐng)域,goctl model 為 goctl 提供的數(shù)據(jù)庫(kù)模型代碼生成指令,目前支持 MySQL、PostgreSQL、Mongo 的代碼生成,本文給大家介紹了go-zero使用goctl生成mongodb的操作使用方法2024-06-06Go語(yǔ)言開(kāi)發(fā)保證并發(fā)安全實(shí)例詳解
這篇文章主要為大家介紹了Go語(yǔ)言開(kāi)發(fā)保證并發(fā)安全實(shí)例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-09-09Go select 死鎖的一個(gè)細(xì)節(jié)
這篇文章主要給大家分享的是Go select 死鎖的一個(gè)細(xì)節(jié),文章先是對(duì)主題提出問(wèn)題,然后展開(kāi)內(nèi)容,感興趣的小伙伴可以借鑒一下,希望對(duì)你有所幫助2021-10-10GoLand一鍵上傳項(xiàng)目到遠(yuǎn)程服務(wù)器的方法步驟
我們開(kāi)發(fā)項(xiàng)目常常將項(xiàng)目上傳到linux遠(yuǎn)程服務(wù)器上來(lái)運(yùn)行,本文主要介紹了GoLand一鍵上傳項(xiàng)目到遠(yuǎn)程服務(wù)器的方法步驟,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2022-06-06go語(yǔ)言LeetCode題解1030距離順序排列矩陣單元格
這篇文章主要為大家介紹了go語(yǔ)言LeetCode題解1030距離順序排列矩陣單元格,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-12-12源碼剖析Golang中singleflight的應(yīng)用
這篇文章主要為大家詳細(xì)介紹了如何利用singleflight來(lái)避免緩存擊穿,并剖析singleflight包的源碼實(shí)現(xiàn)和工作原理,感興趣的可以了解下2024-03-03go?build失敗報(bào)方法undefined的解決過(guò)程
go build命令用于編譯我們指定的源碼文件或代碼包以及它們的依賴包,下面這篇文章主要給大家介紹了關(guān)于go?build失敗報(bào)方法undefined的解決過(guò)程,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-11-11