【API 设计之道】04 字段掩码模式:让前端决定后端返回什么

大家好,我是Tony Bai。

欢迎来到我们的专栏 《API 设计之道:从设计模式到 Gin 工程化实现》的第四讲。

上一讲中,我们解决了那些无法被 CRUD 囊括的复杂业务逻辑。今天,我们将目光转向数据传输的效率问题。

在日常开发中,你是否遇到过这样的"拉扯"场景:

场景 A :前端开发了一款 App,在"用户列表页"只需要展示用户的 头像昵称

后端 :直接复用了 GetUser 接口,返回了包含 身份证号家庭住址注册时间最后登录IP 等 50 多个字段的超级大 JSON。

前端 :抱怨说:"我就要两个字段,你给我几 KB 的数据,用户在地铁上信号不好,加载太慢了!能不能给我单写一个 GetUserSimple 接口?"

后端 :心里苦------"为了这点破事又要写个新接口?如果不写,是不是还得定一个 UserSimpleDTO?"

这就陷入了 API 设计中经典的 过度获取(Over-fetching) 困境。

如果我们为每一种前端视图都定制一个后端接口,那就会陷入**"BFF(Backend for Frontend)地狱"**,后端变成了前端的"切图仔";如果我们什么都不管,只返回全量数据,那就是对带宽和客户端内存的犯罪。

GraphQL 的出现很大程度上是为了解决这个问题,但为了这点需求引入整套 GraphQL 基础设施,成本又未免太高。

有没有一种办法,能在保持 RESTful 架构简洁性的同时,实现"按需索取"呢?

答案是肯定的。这就是今天我们要讲的API模式:字段掩码(Field Mask),也被称为"愿望清单(Wish List)"模式。

什么是字段掩码 (Field Mask)?

核心思想非常简单:客户端在请求中通过参数告诉服务端,"我只想要这些字段",服务端据此对响应体进行裁剪。

架构模式视角

在架构设计领域,这种模式被称为 Response Shaping(响应塑形)。它打破了"服务端定义契约,客户端被动接受"的传统模式,赋予了客户端(消费者)定义数据形态的权力。

相关推荐
swipe9 分钟前
为什么 RAG 一定离不开向量检索:从文档向量化到语义搜索的工程实现
前端·llm·agent
OpenTiny社区37 分钟前
AI-Extension:让 AI 真的「看得到、动得了」你的浏览器
前端·ai编程·mcp
IT_陈寒39 分钟前
Redis缓存击穿:3个鲜为人知的防御策略,90%开发者都忽略了!
前端·人工智能·后端
农夫山泉不太甜2 小时前
Tauri v2 实战代码示例
前端
yuhaiqiang2 小时前
被 AI 忽悠后,开始怀念搜索引擎了?
前端·后端·面试
红色石头本尊2 小时前
1-umi-前端工程化搭建
前端
真夜2 小时前
关于对echart盒子设置百分比读取的宽高没有撑开盒子解决方案
前端
楠木6853 小时前
RAG 资料库 Demo 完整开发流程
前端·ai编程
肠胃炎3 小时前
挂载方式部署项目
服务器·前端·nginx
像我这样帅的人丶你还3 小时前
使用 Next.js + Prisma + MySQL 开发全栈项目
前端