Golang中使用Swagger生成API文檔的流程步驟
Swagger 是一款強(qiáng)大的 API 文檔生成工具，可以幫助開(kāi)發(fā)者輕松創(chuàng)建、管理和展示 RESTful API 文檔。在本文中，我們將介紹如何在 Golang 項(xiàng)目中使用 Swagger 來(lái)生成 API 文檔。
官網(wǎng)地址 ： gin-swagger
前提條件
- Golang 開(kāi)發(fā)環(huán)境（推薦使用 Go 1.16 或更高版本）
- Go Modules 管理工具
- 已安裝的 Git 工具
第一步：安裝 Swagger 工具
在開(kāi)始之前，我們需要安裝 Swagger 工具。你可以使用以下命令來(lái)安裝 Swagger：
go install github.com/swaggo/swag/cmd/swag@latest
安裝完成后，可以通過(guò)運(yùn)行以下命令來(lái)驗(yàn)證安裝是否成功：
swag --v
第二步：安裝 Swaggo 依賴
Swaggo 是一個(gè)用于 Golang 的 Swagger 文檔生成器。我們需要在項(xiàng)目中安裝 Swaggo 依賴：
go get -u github.com/swaggo/swag/cmd/swag go get -u github.com/swaggo/gin-swagger go get -u github.com/swaggo/files go get -u github.com/swaggo/swag
第三步：編寫(xiě) API 代碼
接下來(lái)，我們編寫(xiě)一個(gè)簡(jiǎn)單的 API 示例。在項(xiàng)目根目錄下創(chuàng)建一個(gè) main.go 文件，并添加以下內(nèi)容：
package main
import (
"github.com/gin-gonic/gin"
"github.com/swaggo/gin-swagger"
"github.com/swaggo/gin-swagger/swaggerFiles"
_ "go-swagger-example/docs"
)
// @title Swagger Example API
// @version 1.0
// @description This is a sample server Petstore server.
// @termsOfService http://swagger.io/terms/
// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @host localhost:8080
// @BasePath /api/v1
func main() {
r := gin.Default()
// Simple group: v1
v1 := r.Group("/api/v1")
{
v1.GET("/hello", helloHandler)
}
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
r.Run()
}
// helloHandler godoc
// @Summary Show a hello message
// @Description get string message
// @Tags example
// @Accept json
// @Produce json
// @Success 200 {string} string "ok"
// @Router /hello [get]
func helloHandler(c *gin.Context) {
c.JSON(200, gin.H{
"message": "hello world",
})
}
第四步：生成 Swagger 文檔
在編寫(xiě)好 API 代碼后，我們可以使用 Swaggo 生成 Swagger 文檔。在項(xiàng)目根目錄下運(yùn)行以下命令：
swag init
運(yùn)行此命令后，會(huì)在項(xiàng)目根目錄下生成 docs 文件夾，其中包含生成的 Swagger 文檔。
第五步：運(yùn)行項(xiàng)目并訪問(wèn) Swagger UI
最后，我們運(yùn)行項(xiàng)目，并訪問(wèn) Swagger UI。運(yùn)行以下命令啟動(dòng)項(xiàng)目：
go run main.go
在瀏覽器中訪問(wèn) http://localhost:8080/swagger/index.html，即可看到生成的 Swagger UI 頁(yè)面，其中包含了我們編寫(xiě)的 API 文檔。
以上就是Golang中使用Swagger生成API文檔的流程步驟的詳細(xì)內(nèi)容，更多關(guān)于Golang Swagger生成API文檔的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
Go語(yǔ)言調(diào)用其它程序并獲得程序輸出的方法
這篇文章主要介紹了Go語(yǔ)言調(diào)用其它程序并獲得程序輸出的方法,實(shí)例分析了Go調(diào)用cmd程序的技巧,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-02-02
這篇文章主要介紹了Golang 拷貝Array或Slice的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2021-04-04
Go中使用操作符進(jìn)行數(shù)學(xué)運(yùn)算的示例代碼
在編程中有效地執(zhí)行數(shù)學(xué)運(yùn)算是一項(xiàng)需要開(kāi)發(fā)的重要技能,本文主要介紹了Go中使用操作符進(jìn)行數(shù)學(xué)運(yùn)算的示例代碼,具有一定的參考價(jià)值,感興趣的可以了解一下2023-10-10
這篇文章主要介紹了golang官方嵌入文件到可執(zhí)行程序,本文通過(guò)示例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-02-02
goland Duration 和time的區(qū)別說(shuō)明
這篇文章主要介紹了goland Duration 和time的區(qū)別說(shuō)明，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-12-12
在Go語(yǔ)言中,反射是通過(guò)reflect包來(lái)實(shí)現(xiàn)的,通過(guò)使用反射,我們可以在運(yùn)行時(shí)獲取對(duì)象的類型信息、訪問(wèn)對(duì)象的字段和方法、動(dòng)態(tài)調(diào)用方法等,反射在很多場(chǎng)景下都非常有用,比如編寫(xiě)通用的代碼、實(shí)現(xiàn)對(duì)象的序列化和反序列化、實(shí)現(xiàn)依賴注入等,需要的朋友可以參考下2023-10-10
Go語(yǔ)言的集合稱為映射(map)，它是一種無(wú)序的鍵值對(duì)(key-value)的集合，集合是通過(guò)鍵(key)來(lái)快速檢索值(value)的，鍵(key)類似于索引，它指向值(value)的數(shù)據(jù)，這篇文章主要介紹了GO集合map使用總結(jié),本文通過(guò)示例代碼給大家介紹的非常詳細(xì)，需要的朋友可以參考下2023-06-06
這篇文章主要介紹了Go之interface的具體使用,小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-03-03
這篇文章主要介紹了Golang并發(fā)編程，在許多環(huán)境中，實(shí)現(xiàn)對(duì)共享變量的正確訪問(wèn)所需要的微妙之處使并發(fā)編程變得困難。Go鼓勵(lì)一種不同的方法，在這種方法中，共享值在通道中傳遞，實(shí)際上，從不由單獨(dú)的執(zhí)行線程主動(dòng)共享2023-04-04
這篇文章主要介紹了Go語(yǔ)言io?pipe源碼分析詳情，pipe是一個(gè)適配器,用于連接Reader和Writer，pipe的方法不多,新的寫(xiě)法卻不少，并且結(jié)構(gòu)體分兩塊，讀寫(xiě)信道和結(jié)束標(biāo)識(shí)，下面進(jìn)入文章了解具體的內(nèi)容吧2022-02-02