0

0

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

P粉602998670

P粉602998670

发布时间:2026-01-03 08:20:54

|

449人浏览过

|

来源于php中文网

原创

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 解析,中文变乱码。

PictoGraphic
PictoGraphic

AI驱动的矢量插图库和插图生成平台

下载
  • 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,但你没实现子路径逻辑。

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

  • 注册路由时严格写全路径: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如何定义变量

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

176

2024.02.23

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

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

225

2024.02.23

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

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

335

2024.02.23

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

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

206

2024.03.05

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

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

388

2024.05.21

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

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

194

2025.06.09

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

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

189

2025.06.10

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

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

191

2025.06.17

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

177

2025.12.31

热门下载

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

精品课程

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

共46课时 | 2.7万人学习

AngularJS教程
AngularJS教程

共24课时 | 2.2万人学习

CSS教程
CSS教程

共754课时 | 17.5万人学习

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

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