JSON、表单、图片接口的响应设计:先让客户端能判断“成功与否”
三类接口的响应设计应共用同一套判定规则:状态码与响应体一致、错误对象结构固定、内容协商明确。JSON 适合固定信封与字段级错误,表单提交要在 JSON 结果与重定向之间二选一,图片接口的元信息应放头部而不是塞进 JSON 包裹。
「JSON 响应」标签下共 17 篇技术文章,包括《JSON、表单、图片接口的响应设计:先让客户端能判断“成功与》、《JSON、表单与图片接口的响应设计:先定媒体类型,再定错误边》、《JSON、表单与图片接口的响应设计:同一份契约,三种编码》。按发布时间倒序排列,内容持续更新。
三类接口的响应设计应共用同一套判定规则:状态码与响应体一致、错误对象结构固定、内容协商明确。JSON 适合固定信封与字段级错误,表单提交要在 JSON 结果与重定向之间二选一,图片接口的元信息应放头部而不是塞进 JSON 包裹。
三类接口不应共用同一响应外壳:JSON 用稳定的错误结构,表单明确跳转或 JSON 返回,图片返回真实二进制媒体类型。API.PLUS 的具体字段与状态码本次材料未提供,落地需以实际契约为准。
三类接口的响应差异主要在编码方式和调用方,不在契约本身。建议先统一错误语义、状态码类别与缓存语义,再分别确定 JSON 的稳定外层结构、表单的提交后跳转与字段级错误、图片的 Content-Type 与条件请求。错误一律不能伪装成 …
三类接口可以共用一套响应约定:统一状态码语义、统一错误结构、统一字段命名与内容协商规则,载荷格式按场景选择。图片接口应优先返回二进制并配齐缓存与类型头部,而不是默认用 JSON 包 base64。文中给出可迁移的约定与验收清单;AP…
三类接口的响应设计共享同一骨架:状态码定结果类别、Content-Type 声明表示格式、响应体承载细节。差异主要在响应体放什么:JSON 要固定错误结构与数值精度边界,表单接口的响应通常仍是 JSON 并需处理重复提交,图片接口应…
同一套接口里,JSON、表单与图片三类响应应共用一层状态与错误约定,再分别确定载荷形态;图片接口尤其要保证失败时不会返回看似成功的二进制体。文章给出外层结构、字段约定与三类响应的对照表,示例为未执行的演示代码。
响应设计应先把成功响应的媒体类型与失败响应的统一包络定清楚,再处理内容协商、缓存和浏览器行为。JSON 适合结构化数据;表单端点的响应不应默认为 JSON;图片成功响应应返回真实图片,失败则用明确状态码和可解析错误体。API.PLU…
三类接口的差异主要不在成功响应,而在错误怎么送达客户端:JSON 接口用统一错误体,表单接口把校验错误按字段名回填,图片接口必须避免用图片内容类型承载错误。文章给出状态码与 Content-Type 的约定方式、字段命名与空值处理建…
三类接口不能用一套响应模板覆盖:JSON 接口适合统一信封与稳定错误码;表单接口要先区分浏览器原生提交和脚本提交,前者用 303 跳转、后者用 JSON;图片等二进制接口的正文就是负载,错误只能靠状态码与 Content-Type …
共 17 篇文章,第 1 / 2 页