API设计最佳实践：返回易读字段还是要求客户端发起更多API调用

针对你面向合作方开发公共API的场景，优先选择保留原brandId字段+新增brand品牌名字段的调整版方案a，核心原因如下：

• 对外公共API的设计核心是面向使用者的实际需求，而非对齐内部数据库的存储结构。绝大多数调用方获取商品数据时都需要直接使用品牌名称，强制要求调用方发起两次请求不仅会大幅提升合作方的开发成本，也会额外增加双方的接口请求量，拉低整体性能。
• 保留brandId外键字段可以覆盖小众场景需求：如果部分合作方需要基于品牌ID筛选同品牌其他商品、关联调用其他品牌相关接口，保留该字段不会损失原有能力，兼容性更强。
• 还可以进一步提升接口灵活度：新增可选的expand查询参数，默认返回关联的品牌信息，有极致轻量需求的调用方可以传?expand=none仅获取商品基础字段，兼顾不同场景的需求。

方案b仅适用于内部底层原子接口的场景，这类接口供内部上层聚合服务调用，不需要考虑易用性，只需要保证原子性，完全不适用于对外公开的合作方API。

内容的提问来源于stack exchange，提问作者Ben123