0

0

Golang Web项目如何对接前端接口_前后端交互规范说明

P粉602998670

P粉602998670

发布时间:2026-01-16 15:41:02

|

367人浏览过

|

来源于php中文网

原创

接口响应必须统一为JSON格式,顶层字段固定为code、msg、data;code为整数状态码,msg为提示信息,data为业务数据;传参须明确路径(JSON body或form),时间字段严格使用RFC3339格式。

golang web项目如何对接前端接口_前后端交互规范说明

接口返回结构必须统一用 JSON,且顶层字段固定

Go 后端不能直接返回裸数据或 map[string]interface{}前端无法稳定解析。所有 HTTP 接口(GET/POST 等)响应体必须是标准 JSON,顶层结构一致:

{
  "code": 0,
  "msg": "success",
  "data": {}
}

code 为整数:0 表示成功,非 0 表示业务错误(如 4001 表示参数缺失,401 表示未登录);msg 是可读提示,不用于程序判断;data 为实际业务数据,失败时可为 null 或空对象。

  • 不要在中间件或 handler 里用 json.NewEncoder(w).Encode(...) 直接输出原始 map,容易漏字段、类型错乱
  • 定义统一响应结构体,例如:type Resp struct { Code int `json:"code"` Msg string `json:"msg"` Data interface{} `json:"data"` }
  • 避免在 data 中嵌套 code/msg —— 这会破坏前端统一拦截逻辑

前端传参必须走 Content-Type: application/jsonapplication/x-www-form-urlencoded

除非是文件上传,否则禁止用 GET 传复杂参数(如过滤条件数组、嵌套对象)。Gin/Echo 等框架默认不自动解析 GET 查询字符串到结构体深层字段,容易出错。

  • POST /api/user/list 应该用 application/json 传 body:
    {"page": 1, "size": 20, "tags": ["go", "web"]}
  • 若用 form 提交(如登录页),则用 application/x-www-form-urlencoded,后端用 c.ShouldBind(&req)(Gin)或 r.ParseForm() + 显式取值
  • 禁止混合使用:URL query + JSON body,会导致参数来源混乱,调试困难
  • Gin 中若用 c.ShouldBindJSON(),请求头没带 Content-Type: application/json 会静默失败(返回空结构体),务必检查 header

401403 必须严格区分,且响应体仍需符合统一格式

前端依赖状态码路由跳转或弹窗,但不能只靠状态码判断错误类型 —— 某些代理或 CDN 会重写 status code,所以 code 字段和 HTTP 状态码要协同一致。

LAIKA
LAIKA

LAIKA 是一个创意伙伴,您可以训练它像您(或您想要的任何人)一样写作。

下载

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

  • 未登录:HTTP 状态码设为 401code 字段填 401msg 可为 "login required"
  • 权限不足:HTTP 状态码用 403code403msg"no permission"
  • 其他业务错误(如库存不足):HTTP 状态码仍用 200,靠 code 区分,避免触发前端全局 error 拦截器误跳转
  • 所有情况都必须返回完整 {code, msg, data} 结构,不能只写 http.Error(w, "...", 401)

时间字段统一用 RFC3339 格式字符串,禁止传 Unix 时间戳或自定义格式

前端 Date 对象对时间字符串解析容错性差,2024-05-20 14:30:001716225000 都可能被误读为本地时间或 NaN。

  • Go 中序列化时间字段必须用:time.Time.Format(time.RFC3339),例如 "2024-05-20T14:30:00+08:00"
  • 结构体中时间字段应声明为 time.Time,并加 JSON tag:CreatedAt time.Time `json:"created_at"`
  • 不要在 SQL 查询里用 UNIX_TIMESTAMP()DATE_FORMAT() 拼字符串 —— 交给 Go 层统一格式化
  • 前端收到后可用 new Date(str) 直接解析,无需额外适配
跨域、CSRF、敏感字段脱敏这些点不在接口规范主干里,属于部署和安全配置范畴。真正让前后端不撕逼的,是坚持这四条:结构定死、传参路径清晰、状态码与业务码对齐、时间格式无歧义。其余都是锦上添花。

相关专题

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

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

178

2024.02.23

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

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

226

2024.02.23

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

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

337

2024.02.23

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

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

208

2024.03.05

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

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

391

2024.05.21

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

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

196

2025.06.09

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

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

191

2025.06.10

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

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

192

2025.06.17

C++ 单元测试与代码质量保障
C++ 单元测试与代码质量保障

本专题系统讲解 C++ 在单元测试与代码质量保障方面的实战方法,包括测试驱动开发理念、Google Test/Google Mock 的使用、测试用例设计、边界条件验证、持续集成中的自动化测试流程,以及常见代码质量问题的发现与修复。通过工程化示例,帮助开发者建立 可测试、可维护、高质量的 C++ 项目体系。

8

2026.01.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

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

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