0

0

怎样用Golang构建一个待办事项API 使用Gin框架实现RESTful接口

P粉602998670

P粉602998670

发布时间:2025-07-19 08:28:02

|

540人浏览过

|

来源于php中文网

原创

如何用golang和gin构建一个待办事项api?1. 初始化项目结构,安装go与gin,并创建包含main.go、models/todo.go、handlers/todo_handler.go和routes.go的目录;2. 定义数据结构,在models中声明todo结构体并使用全局变量模拟数据库;3. 设计restful接口,包括获取全部待办、创建、查询、更新和删除接口;4. 编写处理函数实现具体逻辑,并在routes.go中配置对应路由;5. 在main.go中启动服务并测试api功能,通过curl或postman验证接口运行结果。

怎样用Golang构建一个待办事项API 使用Gin框架实现RESTful接口

用 Golang 构建一个待办事项 API,Gin 是个非常合适的选择。它轻量、高效,而且上手相对容易,适合快速搭建 RESTful 接口。下面我们就一步步来看看怎么用 Gin 实现一个基础但实用的待办事项服务。

怎样用Golang构建一个待办事项API 使用Gin框架实现RESTful接口

初始化项目结构

首先你得准备好开发环境,确保安装了 Go 和 Gin。然后新建一个项目目录,初始化模块:

怎样用Golang构建一个待办事项API 使用Gin框架实现RESTful接口
go mod init todo-api

接着安装 Gin:

立即学习go语言免费学习笔记(深入)”;

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

项目结构可以简单一点,比如这样:

怎样用Golang构建一个待办事项API 使用Gin框架实现RESTful接口
todo-api/
├── main.go
├── models/
│   └── todo.go
├── handlers/
│   └── todo_handler.go
└── routes.go

这个结构清晰又便于扩展,models 放数据模型,handlers 处理逻辑,routes 管理路由。


定义待办事项的数据结构和接口

models/todo.go 中定义结构体:

package models

type Todo struct {
    ID     string `json:"id"`
    Title  string `json:"title"`
    Done   bool   `json:"done"`
}

然后准备一个全局变量来模拟数据库(先不涉及真实数据库):

var Todos = []Todo{}

接下来是接口设计,RESTful 风格通常包括这几个接口:

  • GET /todos — 获取全部待办事项
  • POST /todos — 创建一个新的待办
  • GET /todos/:id — 获取某个具体待办
  • PUT /todos/:id — 更新某个待办
  • DELETE /todos/:id — 删除某个待办

编写处理函数和路由配置

handlers/todo_handler.go 里写处理函数,例如添加一个新待办:

LongShot
LongShot

LongShot 是一款 AI 写作助手,可帮助您生成针对搜索引擎优化的内容博客。

下载
func CreateTodo(c *gin.Context) {
    var newTodo models.Todo
    if err := c.BindJSON(&newTodo); err != nil {
        return
    }
    models.Todos = append(models.Todos, newTodo)
    c.IndentedJSON(http.StatusCreated, newTodo)
}

类似地写出其他操作函数,比如获取全部、按 ID 查询等。

然后在 routes.go 中注册路由:

func SetupRoutes(r *gin.Engine) {
    r.GET("/todos", handlers.GetTodos)
    r.POST("/todos", handlers.CreateTodo)
    r.GET("/todos/:id", handlers.GetTodoByID)
    r.PUT("/todos/:id", handlers.UpdateTodo)
    r.DELETE("/todos/:id", handlers.DeleteTodo)
}

最后在 main.go 启动服务:

func main() {
    r := gin.Default()
    routes.SetupRoutes(r)
    r.Run(":8080")
}

测试和运行你的API

启动服务后,可以用 curl 或 Postman 来测试各个接口是否正常。

比如创建一个待办事项:

curl -X POST http://localhost:8080/todos -H "Content-Type: application/json" -d '{"id":"1","title":"学习Gin","done":false}'

或者获取所有待办:

curl http://localhost:8080/todos

如果都能返回正确结果,说明基本功能已经跑通了。

这时候你可以考虑进一步优化,比如加中间件做日志记录、引入真正的数据库如 SQLite 或 MongoDB、加验证逻辑等等。


基本上就这些。虽然只是一个简单的例子,但已经能体现出 Gin 的简洁与高效。后续想扩展也不难,只要把结构组织好就行。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

184

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

229

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

344

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

210

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

397

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

282

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

194

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

498

2025.06.17

AO3官网入口与中文阅读设置 AO3网页版使用与访问
AO3官网入口与中文阅读设置 AO3网页版使用与访问

本专题围绕 Archive of Our Own(AO3)官网入口展开,系统整理 AO3 最新可用官网地址、网页版访问方式、正确打开链接的方法,并详细讲解 AO3 中文界面设置、阅读语言切换及基础使用流程,帮助用户稳定访问 AO3 官网,高效完成中文阅读与作品浏览。

20

2026.02.02

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 3.2万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.5万人学习

Git中文开发手册
Git中文开发手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号