这两种 API 设计哪种更好?

landfill · 6 小时前 · 1030 次点击
编程语言是 Java 。 不知道弱类型的语言会有什么不同吗

POST /api/parse/message-type-a
POST /api/parse/message-type-b
每个 API 返回对应类型的 payload


POST /api/parse
请求体中带上 message type ,返回一个包装后的 payload


每个 type 返回的字段差别挺大的,type 现在有十来个,未来还有可能增加
举报· 1030 次点击
登录 注册 站外分享
9 条回复  
lwldcr 小成 6 小时前
我喜欢第一种 api 指向精准 下游处理也方便 不需要做类型判别啥的 当然如果前端需要在某个地方支持多种 payload 展示,那第一种估计就不满足或者比较难用了
xiaohupro 小成 6 小时前
可以用路径参数来解决,例如你如果是使用 SpringBoot 的话: @PostMapping("/parse/{messageType}") public CommResp parseByMessageType(@PathVariable("messageType") String messageType) { // 在里面根据参数 messageType 做具体的操作 } 不过如果只是根据消息类型获取内容,我建议使用 GET ,不过用 POST 也行,个人习惯问题
landfill 楼主 初学 6 小时前
@xiaohupro 这个等于是第二种方案吧 只是 type 放到了路径参数里
8355 小成 6 小时前
我会选择方案 1 ,枚举值可以自定的情况下这个方案更好,资源型查询型接口可以更方便的套 cdn 等等,迭代风险也低,更加灵活,还可以通过路由做分流等等。 弱类型语言更习惯用方案 2 ,数据大多数来自于查表一套写完逻辑不变的话基本免维护。
sankooc 小成 6 小时前
我个人喜欢第一种 后期做统计稍微简单一些
liuhuihao 初学 6 小时前
[每个 type 返回的字段差别挺大的] ,根据这个我会选择方案一。如果一个接口,连自己内部返回的字段都不固定的话,维护起来会很困难,尤其是日积月累增加了多种类型之后。
sagaxu 初学 5 小时前
如果能把 payload 类型统一化,放一个请求路径没问题。如果统一不了,最好还是拆分成不同的 API 。
chendy 初学 5 小时前
放路径里 在 url 上多暴露一些东西有助于后面的分析统计和问题排查
xuanbg 小成 4 小时前
没啥本质区别,我喜欢第二种,能少很多事
返回顶部