当前位置:首页 > 文章列表 > Golang > Go教程 > Golang构建RESTAPI教程与实现方法

Golang构建RESTAPI教程与实现方法

2026-01-02 13:31:37 0浏览 收藏

哈喽!今天心血来潮给大家带来了《Golang构建REST API教程及实现方法》,想必大家应该对Golang都不陌生吧,那么阅读本文就都不会很困难,以下内容主要涉及到,若是你正在学习Golang,千万别错过这篇文章~希望能帮助到你!

net/http 可直接启动轻量 REST 服务:用 http.ListenAndServe 启动,http.HandleFunc 注册严格路径路由,handler 中需手动读取并校验 req.Body、设置 Content-Type 为 application/json;注意 req.Body 只能读一次、ServeMux 前缀匹配陷阱及显式处理 404。

如何使用Golang构建基础的REST API_Golang REST API接口设计与实现方法

net/http 启动最简 REST 服务,别急着上框架

Go 自带的 net/http 足够支撑大多数基础 API 场景,启动快、依赖少、逻辑透明。过度依赖 ginecho 容易掩盖路由分发、中间件执行顺序、错误传播路径等关键细节。

  • 直接调用 http.ListenAndServe(":8080", nil) 即可启动服务,nil 表示使用默认的 http.DefaultServeMux
  • http.HandleFunc("/users", handlerFunc) 注册路由,注意路径末尾不自动匹配子路径(/users/users/123
  • 所有 handler 函数签名必须是 func(http.ResponseWriter, *http.Request),返回值不能传 error,需手动写入响应
  • 别在 handler 里 panic——Go 的 HTTP server 不会 recover,一次 panic 就整条连接挂掉

解析 JSON 请求体时,json.Unmarshal 前必须先读取 req.Body

常见错误是直接对 req.Body 多次调用 json.Unmarshal,结果第二次开始全为零值。因为 req.Body 是单向流,读完即空。

  • 务必用 io.ReadAll(req.Body) 一次性读出全部字节,再传给 json.Unmarshal
  • 记得在读取前检查 req.Methodreq.Header.Get("Content-Type"),避免对 GET 请求尝试读 body
  • 若需复用 body(如日志或鉴权),应提前用 req.Body = io.NopCloser(bytes.NewBuffer(data)) 包装回 io.ReadCloser
data, err := io.ReadAll(req.Body)
if err != nil {
    http.Error(w, "bad request body", http.StatusBadRequest)
    return
}
var u User
if err := json.Unmarshal(data, &u); err != nil {
    http.Error(w, "invalid JSON", http.StatusBadRequest)
    return
}

返回 JSON 响应时,Content-Type 必须显式设置为 application/json; charset=utf-8

不设 header 导致前端 fetch().json() 报错 “Unexpected token”,浏览器可能按 text/html 解析,中文变乱码。

  • w.Header().Set("Content-Type", "application/json; charset=utf-8") 显式声明
  • 避免用 fmt.Fprintf 直接输出 JSON 字符串——它不处理转义、不控制精度、不兼容结构体字段 tag(如 json:"name,omitempty"
  • json.NewEncoder(w).Encode(v) 替代 json.Marshal + Write,前者支持流式编码,内存更友好
w.Header().Set("Content-Type", "application/json; charset=utf-8")
if err := json.NewEncoder(w).Encode(map[string]string{"status": "ok"}); err != nil {
    http.Error(w, "encode error", http.StatusInternalServerError)
}

路由设计要避开 http.ServeMux 的路径匹配陷阱

http.ServeMux 只做前缀匹配,且不区分 trailing slash,/api 会意外匹配到 /api/users 并交给同一 handler,但你没实现子路径逻辑。

  • 注册路由时严格写全路径:http.HandleFunc("/api/users", listUsers),不要只写 /api
  • 需要层级路由,自己做路径分割:strings.Split(strings.TrimPrefix(req.URL.Path, "/api"), "/")
  • 404 处理不能依赖框架自动 fallback——http.NotFound(w, req) 必须显式调用,否则返回空 200
  • 如果 URL 含查询参数(如 /users?limit=10),用 req.URL.Query().Get("limit") 获取,别手撕 req.URL.RawQuery
真正卡住人的从来不是语法,而是 req.Body 只能读一次、http.ServeMux 不校验路径结尾、JSON 编码器和字符串拼接混用这些细节。写完一个 handler,先 curl 测一遍 status code 和 Content-Type,比跑通单元测试还管用。

今天带大家了解了的相关知识,希望对你有所帮助;关于Golang的技术知识我们会一点点深入介绍,欢迎大家关注golang学习网公众号,一起学习编程~

茶叶包+小苏打,真皮鞋除臭48小时见效茶叶包+小苏打,真皮鞋除臭48小时见效
上一篇
茶叶包+小苏打,真皮鞋除臭48小时见效
PHP源码分析技巧与功能解析方法
下一篇
PHP源码分析技巧与功能解析方法
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    3539次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    3766次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    3763次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    4907次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    4131次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码