系统间接口设计,对话语言统一性如何确保?
- 内容介绍
- 文章标签
- 相关推荐
本文共计5234个文字,预计阅读时间需要21分钟。
原文摘要总结关于极端时间——《Java业务开发错误+100%案例》——我们知道,开发一个服务的第一步就是设计接口。接口的设计需要考虑的细节非常多,例如接口的命名、参数列表、包装结构等。
本文摘录总结于极客时间——《java业务开发错误 100 例》
我们知道,开发一个服务的第一步就是设计接口。接口的设计需要考虑的点非常多,比如接口的命名、参数列表、包装结构体、接口粒度、版本策略、幂等性实现、同步异步处理方式等。这其中,和接口设计相关比较重要的点有三个,分别是包装结构体、版本策略、同步异步处理方式。
今天我们就来聊聊接口设计。
那么先看一个真实案例。曾遇到过一个处理收单的收单中心项目,下单接口返回的响应体中,包含了 success、code、info、message 等属性,以及二级嵌套对象 data 结构体。在对项目进行重构的时候,我们发现真的是无从入手,接口缺少文档,代码一有改动就出错。
有时候,下单操作的响应结果是这样的:success 是 true、message 是 OK,貌似代表下单成功了;但 info 里却提示订单存在风险,code 是一个 5001 的错误码,data 中能看到订单状态是 Cancelled,订单 ID 是 -1,好像又说明没有下单成功。
本文共计5234个文字,预计阅读时间需要21分钟。
原文摘要总结关于极端时间——《Java业务开发错误+100%案例》——我们知道,开发一个服务的第一步就是设计接口。接口的设计需要考虑的细节非常多,例如接口的命名、参数列表、包装结构等。
本文摘录总结于极客时间——《java业务开发错误 100 例》
我们知道,开发一个服务的第一步就是设计接口。接口的设计需要考虑的点非常多,比如接口的命名、参数列表、包装结构体、接口粒度、版本策略、幂等性实现、同步异步处理方式等。这其中,和接口设计相关比较重要的点有三个,分别是包装结构体、版本策略、同步异步处理方式。
今天我们就来聊聊接口设计。
那么先看一个真实案例。曾遇到过一个处理收单的收单中心项目,下单接口返回的响应体中,包含了 success、code、info、message 等属性,以及二级嵌套对象 data 结构体。在对项目进行重构的时候,我们发现真的是无从入手,接口缺少文档,代码一有改动就出错。
有时候,下单操作的响应结果是这样的:success 是 true、message 是 OK,貌似代表下单成功了;但 info 里却提示订单存在风险,code 是一个 5001 的错误码,data 中能看到订单状态是 Cancelled,订单 ID 是 -1,好像又说明没有下单成功。

