JSON、表单与图片接口的响应设计:错误信封统一,成功载荷分开
三类接口应共用一个外层:HTTP 状态码分层、统一的错误信封(机器码、可读信息、追踪标识、字段级明细),成功载荷则按媒体类型分开——JSON 返回可演进的对象,表单接口把校验错误映射回字段路径,图片接口返回二进制流并在头部声明类型、…
「API 响应设计」标签下共 7 篇技术文章,包括《JSON、表单与图片接口的响应设计:错误信封统一,成功载荷分》、《JSON、表单与图片接口的响应设计规范:统一契约后,错误与二》、《JSON、表单、图片接口的响应设计规范:判定信号、错误定位与》。按发布时间倒序排列,内容持续更新。
三类接口应共用一个外层:HTTP 状态码分层、统一的错误信封(机器码、可读信息、追踪标识、字段级明细),成功载荷则按媒体类型分开——JSON 返回可演进的对象,表单接口把校验错误映射回字段路径,图片接口返回二进制流并在头部声明类型、…
三类接口应共用外层契约:用 HTTP 状态码表达结果类别,用固定错误体携带 code、message、request_id,成功载荷再按媒体类型分开。JSON 返回顶层对象并明确分页与精度;表单响应用字段级错误定位;图片成功时返回二…
三类接口应共用一套成功判定信号:HTTP 状态码加内容类型;JSON 用稳定错误码与字段级错误,表单校验失败用 422 并把错误落到字段名,图片接口成功即返回图片字节、失败才返回结构化错误体。文中给出可复用的契约清单和部分成功、限流…
三类端点的差别不在 JSON 好不好看,而在客户端判定成功的信号顺序:JSON 依赖状态码与可解析体,表单类依赖状态码与 Location,图片类依赖 Content-Type 与字节完整性。规范应先写清判定顺序与失败时的可读错误,…
三类端点的成功响应形态不同:JSON 返回可解析结构,浏览器表单返回重定向或 HTML,图片返回字节流。因此错误契约应按端点类型分别定义:JSON 与 API 表单用结构化错误体,浏览器表单返回 HTML 或重定向,图片端点出错时不…
三类接口不该共用一套万能返回体:JSON 端点要固定成功形态并给出字段级错误对象;表单端点要区分浏览器提交与 fetch 调用,成功跳转、失败回填并前置拦截超大载荷;图片端点要以二进制为主体,把 Content-Type、长度、缓存…
响应契约设计的核心是让 Content-Type 与 HTTP 状态码承载语义:JSON 接口保持字段类型稳定并回传 request_id,表单写入用 303 或 422 讲清结果,图片接口按 Accept 决定成功与失败皆返回什么…
共 7 篇文章,第 1 / 1 页