JSON、表单与图片接口的响应设计:三类返回各自的约定与边界
三类接口不能用一套响应模板覆盖:JSON 接口适合统一信封与稳定错误码;表单接口要先区分浏览器原生提交和脚本提交,前者用 303 跳转、后者用 JSON;图片等二进制接口的正文就是负载,错误只能靠状态码与 Content-Type …
「JSON 响应」标签下共 18 篇技术文章。按发布时间倒序排列,内容持续更新。
三类接口不能用一套响应模板覆盖:JSON 接口适合统一信封与稳定错误码;表单接口要先区分浏览器原生提交和脚本提交,前者用 303 跳转、后者用 JSON;图片等二进制接口的正文就是负载,错误只能靠状态码与 Content-Type …
JSON、表单和图片接口可以共用一套错误信封,但成功响应应按媒体类型分别定义;用状态码、Content-Type 和缓存头区分,避免把错误包装成 200 或伪装成图片。表单需区分浏览器与 AJAX,图片错误不得污染缓存。
三类接口应共用一个外层:HTTP 状态码分层、统一的错误信封(机器码、可读信息、追踪标识、字段级明细),成功载荷则按媒体类型分开——JSON 返回可演进的对象,表单接口把校验错误映射回字段路径,图片接口返回二进制流并在头部声明类型、…
三类接口应共用外层契约:用 HTTP 状态码表达结果类别,用固定错误体携带 code、message、request_id,成功载荷再按媒体类型分开。JSON 返回顶层对象并明确分页与精度;表单响应用字段级错误定位;图片成功时返回二…
三类接口可共享同一套状态码与错误语义,再按载荷分别约束 Content-Type、正文形态和失败回退;成功与失败不能用同一形状表达,图片接口尤其不能在出错时返回图片字节。API.PLUS 的具体字段与错误码需以其官方文档为准。
响应设计应先按客户端消费路径区分 JSON、表单和图片三类契约,再共享状态码、可机器读取的错误体与可追踪标识;图片失败时不要伪装成成功图片。API.PLUS 的具体端点与错误码需以官方文档为准。
三类接口的响应设计要先按载荷形态分开(JSON 结构化数据、表单提交后的结构化回执、图片二进制流),再用同一套错误结构收口。关键约束是 Content-Type 准确、错误不伪装成 200、图片接口把元信息放头部而非塞进 JSON、…
响应契约设计的核心是让 Content-Type 与 HTTP 状态码承载语义:JSON 接口保持字段类型稳定并回传 request_id,表单写入用 303 或 422 讲清结果,图片接口按 Accept 决定成功与失败皆返回什么…
文章给出 JSON、表单、图片三类接口的响应设计约定:JSON 用统一四字段信封与稳定错误码,表单按 Accept 做内容协商并返回字段级错误,图片默认返回二进制、需要元数据时切 JSON,并统一携带 request_id 便于追踪…
共 18 篇文章,第 2 / 2 页