讲师中心 微信公众号
AI工具推荐 视频效率加速

如何为Go API返回结构化错误_Go API错误结构设计指南

云辰大大_2815

云辰大大_2815

发布时间:2025-12-19 20:11:32

|

658人浏览过

|

来源于php中文网

原创

Go API结构化错误的核心是统一JSON格式,含Status、Code、Message、Detail(debug模式)、RequestID字段;需分层封装、避免裸error透出,集成HTTP处理器并设正确状态码,支持i18n与错误码文档化。

如何为go api返回结构化错误_go api错误结构设计指南

Go API 返回结构化错误的核心是:统一错误格式、区分错误类型、保留原始上下文、便于前端解析。不建议直接返回 error 字符串或裸 panic,而应设计可序列化、含状态码、错误码、用户提示和调试信息的 JSON 错误响应。

定义标准错误结构体

一个实用的错误结构需包含 HTTP 状态码、业务错误码、用户友好的消息、机器可读的错误 ID(可选)、以及开发用的详细原因(仅 debug 模式暴露):

  • Status:对应 HTTP 状态码(如 400、401、404、500)
  • Code:自定义业务错误码(如 "USER_NOT_FOUND"、"INVALID_EMAIL"),字符串更易维护和国际化
  • Message:面向终端用户的简明提示(如 "用户不存在")
  • Detail:可选字段,仅在 debug=true 时返回(如具体校验失败字段、SQL 错误原文)
  • RequestID:关联日志追踪,方便后端排查

示例结构:

type APIError struct {
    Status    int    `json:"status"`
    Code      string `json:"code"`
    Message   string `json:"message"`
    Detail    string `json:"detail,omitempty"`
    RequestID string `json:"request_id,omitempty"`
}

func (e *APIError) Error() string { return e.Message }

分层封装错误,避免裸 error 透出

不要让数据库错误、JSON 解析错误等底层 error 直接返回给客户端。应在 handler 层统一拦截并转换:

Web fetch markdown of page
Web fetch markdown of page

通过 jina.ai 将网页抓取为精简的 markdown,用于在需要获取 URL 并获取压缩的 markdown 内容以节省 token。触发词 l...

下载
  • 使用中间件或 defer 捕获 panic,并转为 500 类错误
  • 对已知业务错误(如用户未登录、权限不足)主动构造 *APIError
  • 对未知错误(如第三方服务超时、DB 连接失败)统一降级为 500 + 通用码(如 "INTERNAL_ERROR"),不暴露敏感细节
  • 可借助 errors.Is / errors.As 判断错误类型,再做映射(例如识别 pgx.ErrNoRows → 404 + "USER_NOT_FOUND")

与 HTTP 处理器集成(以 net/http 为例)

在 handler 中返回错误时,不直接写 http.Error,而是统一调用一个响应函数:

  • 成功时:writeJSON(w, http.StatusOK, data)
  • 失败时:writeError(w, err) —— 内部判断是否为 *APIError,否则包装为 500
  • 确保 Content-Type 设为 application/json; charset=utf-8
  • 设置合适的 HTTP 状态码(别让所有错误都返回 200 + {“error”:…})

这样前端可通过 HTTP 状态码快速区分网络/服务异常 vs 业务异常。

可选增强:支持 i18n 与错误码文档化

若需多语言支持,Message 不宜硬编码,可改为 key(如 "user.not_found"),由前端或网关根据 Accept-Language 渲染;同时维护一份公开的错误码表(Markdown 或 OpenAPI x-error-codes 扩展),标注每个 Code 对应的场景、HTTP 状态、是否可重试等,提升协作效率。

基本上就这些。结构化错误不是堆砌字段,而是让错误成为 API 的一部分契约 —— 前端能预期、后端好定位、运维可追踪。

热门AI工具

更多
立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

4043

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

851

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

1049

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

5921

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

2823

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

5900

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

7861

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

1070

2024.04.29

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

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

共101课时 | 20.8万人学习

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

共39课时 | 4.8万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn