golang快速入门--web--基于gin快速构建restful

最新推荐文章于 2023-12-03 10:30:11 发布

Mr.Lee jack

最新推荐文章于 2023-12-03 10:30:11 发布

阅读量161

点赞数

分类专栏： go 文章标签： go语言 go入门 web

本文链接：https://blog.youkuaiyun.com/xzpdxz/article/details/117960124

版权

go 专栏收录该内容

17 篇文章

订阅专栏

web框架Gin

文档参考

gin-swagger
swag

依赖安装

go get -u github.com/swaggo/swag/cmd/swag
go get -u github.com/swaggo/files
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/gin-swagger/swaggerFiles
go get -u github.com/swaggo/swag/example/basic/web

代码样例

package main

import (
	"fmt"
	_ "gin-test/docs"
	"github.com/gin-gonic/gin"
	"github.com/swaggo/gin-swagger"
	"github.com/swaggo/gin-swagger/swaggerFiles"
	"net/http"
)

// Test @description 测试接口1
// @success 200
// @router /test [get]
func Test(c *gin.Context) {
	// 测试接口
	c.String(http.StatusOK, "ok")
}

type Test2Response struct {
	// 测试2接口响应体，注意大写
	Id    string `json:"id" example:"1"`
	Query string `json:"query" example:"account name"`
}

// Test2 @description 测试接口2
// @Summary 测试接口2
// @Tags 测试
// @Produce  json
// @param id path int true "测试id"
// @param query query string true "query参数"
// @Success 200 {object} Test2Response ""
// @Failure 400 {object} string "400"
// @Failure 404 {object} string "404"
// @Router /test2/{id} [post]
func Test2(c *gin.Context) {
	_id, _ := c.Params.Get("id")
	_query := c.Query("query")
	fmt.Println("------")
	//c.JSON(http.StatusOK, out)
	c.JSON(200, gin.H{"id": _id, "query": _query})
}

// @title Gin 测试
// @version 1.0
// @description  Gin 测试
// @host 127.0.0.1:8080
func main() {
	engin := gin.Default()
	engin.GET("/test", Test)
	engin.POST("/test2/:id", Test2)
	engin.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
	engin.Run("127.0.0.1:8080")
}

执行

[ ~ ]# swag init // 将会生产swagger文档
[ ~ ]# go run main.go // 启动服务