知识卡片

普通读书笔记卡 · 3437.c

勿用业务封包掩盖HTTP状态

理解等级:高级

API 若无论成功失败都返回 HTTP 200,再让客户端从 JSON 的自定义 status 判断结果,就把协议已有的结果信号藏进另一层封包。调用方、代理和监控首先看到的仍是 200,难以直接按 HTTP 状态处理。书中的商品查询例子甚至在 result 内再次嵌套 result,增加了取值层级。优先让 HTTP 状态表达请求结果,响应体只承载需要的业务数据或错误详情。分页封包也要看实际需求:若订单列表返回 Page,而订单行直接返回数组,相近接口会出现不一致;这不意味着有分页需求时也必须删掉元数据。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    原书出处

    参考来源

    - 位置:《深入实践DDD:以DSL驱动复杂软件开发》第149章《13.1.2 尽可能使用HTTP作为封包》(源文件:_epub-src/OEBPS/Text/chapter151.xhtml) - 结论依据:原文反对统一返回 200 或 500 后再在消息体内放自定义状态,指出 HTTP 已有类似封包机制,并用双层 `result` 的商品查询 JSON 说明重复封包问题。 - 原始内容:就是不管服务端对请求的处理正常还是异常,都统一返回200的HTTP状态码,消息体则是一个既可以包含正常数据,也可以包含异常信息的联合(Union)数据结构。 这些做法都可以理解为在“按URI语义理应返回的”数据之外添加封包(Envelope)。