欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

Golang使用Swagger文檔教程詳解

 更新時間:2023年12月05日 10:22:38   作者:斷問天  
這篇文章主要為大家詳細介紹Golang使用Swagger文檔教程的相關知識,文中通過示例代碼講解詳細,具有一定的借鑒價值,感興趣的小伙伴可以學習一下

Golang開發(fā)效率是杠杠滴,簡單幾行代碼就可完成一個可用的服務,如下代碼:

  • 采用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 標題
// @version 1.0 版本
// @description NeoApi Service 描述
// @BasePath /api  基礎路徑
// @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 導出數據
// @Description 導出數據
// @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 字段映射默認嚴格駝峰命名,否則取不到值
		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",
	})
}

簡單介紹一下Swagger的使用。

首先導入swagger相關的包

	swaggerFiles "github.com/swaggo/files"
	ginSwagger "github.com/swaggo/gin-swagger"
 
	_ "export/docs"
  • swaggerFiles和ginSwagger是swaggo庫提供
  • export/docs是swag命令生成的本地API文檔源代碼(export是我的項目名稱),在golang里面只需要docs.go,如下:

其次,想要生成swagger文檔也非常簡單,

  • 安裝swag命令行工具:go get github.com/swaggo/swag/cmd/swag@v1.8.12
  • 編寫項目的swagger注釋文檔
  • 執(zhí)行生成命令:swag init 在項目docs目錄下生成相關文件

然后,為swagger注冊gin路由

	r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

最后,啟動服務,訪問地址:Swagger UI 即可,如果想查看json格式的文檔,可訪問地址:localhost:9527/swagger/doc.json

以上就是Golang使用Swagger文檔教程詳解的詳細內容,更多關于Golang使用Swagger文檔的資料請關注腳本之家其它相關文章!

相關文章

  • Go語言的GOPATH與工作目錄詳解

    Go語言的GOPATH與工作目錄詳解

    這篇文章主要介紹了Go語言的GOPATH與工作目錄詳解,本文詳細講解了GOPATH設置、應用目錄結構、編譯應用等內容,需要的朋友可以參考下
    2014-10-10
  • Go語言中實現打印堆棧的errors包的用法詳解

    Go語言中實現打印堆棧的errors包的用法詳解

    因為Go語言提供的錯誤太簡單了,以至于簡單的我們無法更好的處理問題,所以誕生了很多對錯誤處理的庫,github.com/pkg/errors是比較簡潔的一樣,本文就來聊聊它的具體用法吧
    2023-07-07
  • Golang字符串類型原理及其使用方法

    Golang字符串類型原理及其使用方法

    本文主要介紹了Golang字符串類型原理及其使用方法,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧
    2023-09-09
  • 超實用的Golang通道指南之輕松實現并發(fā)編程

    超實用的Golang通道指南之輕松實現并發(fā)編程

    Golang?中的通道是一種高效、安全、靈活的并發(fā)機制,用于在并發(fā)環(huán)境下實現數據的同步和傳遞。本文主要介紹了如何利用通道輕松實現并發(fā)編程,需要的可以參考一下
    2023-04-04
  • GO語言實現二維碼掃碼的示例代碼

    GO語言實現二維碼掃碼的示例代碼

    你對二維碼掃碼的流程有困惑嗎,這篇文章就結合筆者自身的開發(fā)經驗進行分享,讓大家熟悉并掌握此功能,感興趣的小伙伴快跟隨小編一起學習一下吧
    2023-06-06
  • 使用GO語言實現Mysql數據庫CURD的簡單示例

    使用GO語言實現Mysql數據庫CURD的簡單示例

    本文主要介紹了使用GO語言實現Mysql數據庫CURD的簡單示例,文中通過示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下
    2021-08-08
  • golang 整合antlr語法校驗解析

    golang 整合antlr語法校驗解析

    Antlr是一個語法分析器,本身是用java實現的,然是Runtime的庫也支持Golang、Java、Python等,本文給大家講解使用golang整合antlr進行語法解析,感興趣的朋友一起看看吧
    2023-02-02
  • go語言執(zhí)行等待直到后臺goroutine執(zhí)行完成實例分析

    go語言執(zhí)行等待直到后臺goroutine執(zhí)行完成實例分析

    這篇文章主要介紹了go語言執(zhí)行等待直到后臺goroutine執(zhí)行完成的方法,實例分析了Go語言中WaitGroup的使用技巧,需要的朋友可以參考下
    2015-03-03
  • 一文帶你玩轉Golang Prometheus Eexporter開發(fā)

    一文帶你玩轉Golang Prometheus Eexporter開發(fā)

    本文分兩大塊,一是搞清楚prometheus四種類型的指標Counter,Gauge,Histogram,Summary用golang語言如何構造這4種類型對應的指標,二是搞清楚修改指標值的場景和方式,感興趣的可以了解一下
    2023-02-02
  • Go語言實現常見限流算法的示例代碼

    Go語言實現常見限流算法的示例代碼

    計數器、滑動窗口、漏斗算法、令牌桶算法是我們常見的幾個限流算法,本文將依次用Go語言實現這幾個限流算法,感興趣的可以了解一下
    2023-05-05

最新評論