JSON、表单与图片接口的响应设计:错误信封统一,成功载荷分开
三类接口应共用一个外层:HTTP 状态码分层、统一的错误信封(机器码、可读信息、追踪标识、字段级明细),成功载荷则按媒体类型分开——JSON 返回可演进的对象,表单接口把校验错误映射回字段路径,图片接口返回二进制流并在头部声明类型、…
「表单接口」标签下共 10 篇技术文章,包括《JSON、表单与图片接口的响应设计:错误信封统一,成功载荷分》、《JSON、表单与图片接口的响应设计规范:统一契约后,错误与二》、《JSON、表单与图片接口的响应设计:先统一契约,再分开处理载》。按发布时间倒序排列,内容持续更新。
三类接口应共用一个外层:HTTP 状态码分层、统一的错误信封(机器码、可读信息、追踪标识、字段级明细),成功载荷则按媒体类型分开——JSON 返回可演进的对象,表单接口把校验错误映射回字段路径,图片接口返回二进制流并在头部声明类型、…
三类接口应共用外层契约:用 HTTP 状态码表达结果类别,用固定错误体携带 code、message、request_id,成功载荷再按媒体类型分开。JSON 返回顶层对象并明确分页与精度;表单响应用字段级错误定位;图片成功时返回二…
三类接口可共享同一套状态码与错误语义,再按载荷分别约束 Content-Type、正文形态和失败回退;成功与失败不能用同一形状表达,图片接口尤其不能在出错时返回图片字节。API.PLUS 的具体字段与错误码需以其官方文档为准。
响应设计应先按客户端消费路径区分 JSON、表单和图片三类契约,再共享状态码、可机器读取的错误体与可追踪标识;图片失败时不要伪装成成功图片。API.PLUS 的具体端点与错误码需以官方文档为准。
三类接口的响应设计要先按载荷形态分开(JSON 结构化数据、表单提交后的结构化回执、图片二进制流),再用同一套错误结构收口。关键约束是 Content-Type 准确、错误不伪装成 200、图片接口把元信息放头部而非塞进 JSON、…
三类接口应共用一套成功判定信号:HTTP 状态码加内容类型;JSON 用稳定错误码与字段级错误,表单校验失败用 422 并把错误落到字段名,图片接口成功即返回图片字节、失败才返回结构化错误体。文中给出可复用的契约清单和部分成功、限流…
三类端点的成功响应形态不同:JSON 返回可解析结构,浏览器表单返回重定向或 HTML,图片返回字节流。因此错误契约应按端点类型分别定义:JSON 与 API 表单用结构化错误体,浏览器表单返回 HTML 或重定向,图片端点出错时不…
三类端点应分别围绕 JSON 结构、表单提交语义和图片字节设计响应;可以统一错误码,但不宜强推同一 JSON 外壳,并应明确字段错误、内容协商、缓存与上传边界。
三类接口不该共用一套万能返回体:JSON 端点要固定成功形态并给出字段级错误对象;表单端点要区分浏览器提交与 fetch 调用,成功跳转、失败回填并前置拦截超大载荷;图片端点要以二进制为主体,把 Content-Type、长度、缓存…
共 10 篇文章,第 1 / 2 页