当前位置: 首页 > news >正文

Go语言-初学者日记(七):用 Go 写一个 RESTful API 服务!

实践是最好的学习方式!这一篇我们将用 Go + Gin 框架从零开始开发一个用户管理 API 服务。你将学到:

  • 如何初始化项目并引入依赖
  • 如何组织目录结构
  • 如何用 Gin 实现 RESTful 接口
  • 如何通过 curl 测试 API
  • 进阶功能拓展建议

🧰 一、项目初始化与依赖安装

第一步,先创建项目目录并初始化 Go Modules:

mkdir go-user-api && cd go-user-api
go mod init github.com/yourname/go-user-api

然后安装我们将使用的 Web 框架 —— Gin:

go get -u github.com/gin-gonic/gin

✅ 你现在已经具备开发 Go Web 服务的基本环境。


📁 二、推荐的项目目录结构

保持简单,便于理解,也方便未来扩展:

go-user-api/
├── main.go               # 应用入口
├── go.mod                # 模块定义
├── go.sum                # 依赖锁定文件
├── handlers/             # 路由处理逻辑
│   └── user.go
└── models/               # 数据模型结构体(可选)

📌 提醒:随着项目变复杂,可拆分出 service/, middleware/, config/, router/, utils/ 等目录。


🧪 三、实现用户 API 接口

目标是实现两个基础接口:

  • GET /users:返回所有用户数据
  • POST /users:添加一个新用户
📄 main.go
package mainimport ("github.com/gin-gonic/gin""go-user-api/handlers"
)func main() {r := gin.Default()// 注册路由r.GET("/users", handlers.GetUsers)r.POST("/users", handlers.CreateUser)// 启动服务r.Run(":8080")
}
📄 handlers/user.go
package handlersimport ("net/http""github.com/gin-gonic/gin"
)// 模拟用户结构体和数据
type User struct {ID   int    `json:"id"`Name string `json:"name"`
}var users = []User{{ID: 1, Name: "Alice"},{ID: 2, Name: "Bob"},
}// GET /users
func GetUsers(c *gin.Context) {c.JSON(http.StatusOK, users)
}// POST /users
func CreateUser(c *gin.Context) {var newUser Userif err := c.ShouldBindJSON(&newUser); err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}newUser.ID = len(users) + 1users = append(users, newUser)c.JSON(http.StatusCreated, newUser)
}

🧪 四、启动服务并测试接口

启动服务:
go run main.go

服务默认监听 http://localhost:8080

使用 curl 测试接口

📥 获取用户列表:

curl http://localhost:8080/users

📤 添加新用户:

curl -X POST http://localhost:8080/users \-H "Content-Type: application/json" \-d '{"name":"Charlie"}'

返回示例:

{"id": 3,"name": "Charlie"
}

🔧 五、接口设计补充说明

推荐的 RESTful 风格规范如下:

请求方法路径含义
GET/users查询所有用户
GET/users/:id查询单个用户
POST/users创建新用户
PUT/users/:id更新用户信息
DELETE/users/:id删除用户

这些是 RESTful 接口的基本设计规范,在大型项目中非常常见。


📦 六、进阶拓展建议

✅ 想继续提升?你可以尝试:

  • 🗄 使用 GORM + SQLite/MySQL 实现真正的数据库操作
  • ✏️ 使用 Gin 的 binding + validator 添加表单校验
  • 🔐 实现注册登录、JWT 鉴权机制
  • 🧪 编写单元测试:用 httptest.NewRecorder() 模拟请求
  • 🛡️ 使用中间件做访问日志、限流、异常处理等
  • 📂 添加日志框架如 zap,记录结构化日志
  • 🧩 抽离业务逻辑到 service 层,提升代码可维护性
  • 🔧 使用 viper 管理配置文件(支持 YAML、JSON 等)

🧠 七、小结与回顾

本篇我们完成了一个完整的 Go + Gin 实战项目的搭建和基本功能实现。你已经学到了:

  • 如何初始化 Go 项目并安装依赖
  • 如何用 Gin 实现基础的 API 路由与处理
  • 如何通过 curl 工具测试接口
  • 如何组织项目目录结构以支持未来拓展

📌 实战才是学习的核心,加油!后续我们会继续介绍部署与上线技巧 🚀


🪧 下一篇预告

🚀 Go语言-初学者日记(八):部署与构建——Go 项目上线指南
包括 go build 编译、Docker 打包、环境变量配置、部署上线等内容,敬请期待!


http://www.mrgr.cn/news/97254.html

相关文章:

  • JavaScript基础--09-流程控制语句:选择结构(if和switch)
  • Windows 安装和使用 ElasticSearch
  • Python实现ssh自动连接
  • 【双维畅聊】网页版聊天室测试报告
  • 服务器磁盘io性能监控和优化
  • 道路裂缝数据集CrackForest-156-labelme
  • 3D图像重建中Bundle Adjustment的推导与实现
  • 【Python爬虫高级技巧】BeautifulSoup高级教程:数据抓取、性能调优、反爬策略,全方位提升爬虫技能!
  • 001 vue
  • Springboot切换到3.3.4后,使用spring security一些小问题记录
  • PyTorch构建自定义模型
  • Flutter之页面布局
  • $R^n$超平面约束下的向量列
  • 蓝桥云客--破译密码
  • 【机器学习】机器学习工程实战-第4章 特征工程
  • 详解七大排序
  • 博途 TIA Portal之1200与Odot零点PN通讯
  • 【2023】ORIGIN或MATLAB 颜色图,等高图,颜色条——需要拟合补全中间的颜色
  • vs环境中编译osg以及osgQt
  • Drools项目实战