初始化项目并安装gin：创建项目目录后初始化go.mod并安装gin包。2. 创建基础路由：编写main.go文件，引入gin包，定义/ping路由返回json响应。3. 添加用户接口：定义user结构体和用户列表，扩展get /users及get /users/:id接口用于获取用户数据。4. 使用路由分组和中间件：通过group组织api模块，并添加cors支持等中间件。使用gin可快速搭建轻量级高性能的rest api服务，适合入门及快速开发场景。
实现一个简单的 REST API 用 Golang 的 Gin 框架其实挺直接的，尤其是对刚入门或者想快速搭建后端服务的人来说。Gin 是一个轻量级、高性能的 Web 框架，非常适合用来做 API 开发。
下面我来一步步说说怎么用 Gin 快速搭出一个基本可用的 REST API。
初始化项目
首先你需要有一个 Go 环境（1.20+ 比较好），然后创建一个新的项目目录，初始化 go.mod 文件：
立即学习“go语言免费学习笔记（深入）”；
go mod init your_project_name
接着安装 Gin：
go get -u github.com/gin-gonic/gin
这一步完成后，你就可以开始写代码了。
创建基础路由和处理函数
在项目根目录下新建一个 main.go 文件，然后写入以下内容：
package main
import (
"github.com/gin-gonic/gin"
"net/http"
)
func main() {
r := gin.Default()
r.GET("/ping", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{
"message": "pong",
})
})
r.Run(":8080")
}这段代码做了几件事：
- 引入了 Gin 包并创建了一个默认的路由引擎。
- 定义了一个 GET 请求的路由
/ping，返回 JSON 格式的"pong"。 - 启动服务监听 8080 端口。
运行这个程序之后，访问 http://localhost:8080/ping 就能看到返回结果。
添加更多API接口
假设我们想做一个管理“用户”的简单接口，比如获取用户列表、根据 ID 获取某个用户等。
我们可以这样扩展路由：
type User struct {
ID string `json:"id"`
Name string `json:"name"`
}
var users = []User{
{ID: "1", Name: "Alice"},
{ID: "2", Name: "Bob"},
}
func main() {
r := gin.Default()
r.GET("/users", func(c *gin.Context) {
c.JSON(http.StatusOK, users)
})
r.GET("/users/:id", func(c *gin.Context) {
id := c.Param("id")
for _, user := range users {
if user.ID == id {
c.JSON(http.StatusOK, user)
return
}
}
c.JSON(http.StatusNotFound, gin.H{"error": "user not found"})
})
r.Run(":8080")
}这里加了两个接口：
-
GET /users：返回所有用户列表 -
GET /users/:id：根据路径参数返回特定用户
虽然这些逻辑是硬编码的，但足够演示基本结构了。你可以后续替换成数据库查询。
使用分组和中间件（可选）
如果你要开发多个模块，可以使用 Gin 的路由分组功能，让结构更清晰。例如：
api := r.Group("/api")
{
api.GET("/users", func(c *gin.Context) { ... })
api.GET("/users/:id", func(c *gin.Context) { ... })
}还可以加上日志、跨域、鉴权等中间件。比如启用跨域支持：
r.Use(func(c *gin.Context) {
c.Writer.Header().Set("Access-Control-Allow-Origin", "*")
c.Next()
})当然，生产环境建议用官方推荐的中间件包，比如 gin-gonic/cors。
基本上就这些。用 Gin 实现一个简单的 REST API 并不难，关键是把路由和处理函数组织好。随着功能变多，可以考虑拆分成多个文件甚至模块，保持代码整洁。
