Go集成swagger實現(xiàn)在線接口文檔的教程指南

更新時間：2024年11月17日 10:21:43 作者：不是冷冰冰的冰

wagger是一個用于設計,構建和文檔化API的開源框架,在Go語言中,Swagger可以幫助后端開發(fā)人員快速創(chuàng)建和定義RESTful API,并提供自動生成接口文檔的功能,所以本文給大家介紹了Go集成swagger實現(xiàn)在線接口文檔的方法,需要的朋友可以參考下

安裝swaggo

go install github.com/swaggo/swag/cmd/swag@latest

編寫swag

import (
	"github.com/gin-gonic/gin"
	"goWeb/internal/service"
	"goWeb/model/response"
)
 
// UserRouter 路由
func UserRouter(ctx *gin.RouterGroup) {
	ctx.GET("/login", login)
	ctx.POST("/addUser", addUser)
	ctx.GET("/delUser/:id", delUser)
	ctx.GET("/getUser", getUser)
	ctx.GET("/pageUser", pageUser)
}
 
// Login
//
//	@Description	Java學習Golang開發(fā)
//	@Tags			user接口
//	@Router			/user/login [get]
func login(ctx *gin.Context) {
	response.Success(ctx, service.Login())
}
 
// @Description	添加用戶信息
// @Tags		user接口
// @Param		user	body		model.User	true	"用戶實體"
// @Success		200		{string}	string			"success"
// @Failure		500		{string}	string			"fail"
// @Router			/user/addUser [post]
func addUser(ctx *gin.Context) {
	response.Success(ctx, service.AddUser(ctx))
}
 
// @Description	刪除用戶
// @Tags		user接口
// @Param		id	path		int	true	"用戶id"
// @Router			/user/delUser/{id} [get]
func delUser(ctx *gin.Context) {
	service.DelUser(ctx)
	response.Ok(ctx)
}
 
// @Description	刪除用戶
// @Tags		user接口
// @Param		id	query		int	true	"用戶id"
// @Router			/user/getUser [get]
func getUser(ctx *gin.Context) {
	response.Success(ctx, service.GetUser(ctx))
}
 
// @Description	分頁查詢用戶數(shù)據(jù)
// @Tags		user接口
// @Param page query int false "當前頁碼"
// @Param pageSize query int false "每頁數(shù)量"
// @Router			/user/pageUser [get]
func pageUser(ctx *gin.Context) {
	response.Success(ctx, service.PageUser(ctx))
}

啟動類

import (
	swaggerFiles "github.com/swaggo/files"     // swagger embed files
	ginSwagger "github.com/swaggo/gin-swagger" // gin-swagger middleware
	_ "goWeb/docs"
)
 
//	@title			Swagger Example API
//	@version		1.0
//	@description	go web 框架gin集成swagger.
//	@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
 
// @externalDocs.description	OpenAPI
// @externalDocs.url			https://swagger.io/resources/open-api/
func main() {}