1.API设计时的三个自问?
api的期望是什么?
api要保证什么?
api要保持不变的是什么?
api要保证和接口所预期的输入(符合接口接收的参数,不符合的参数直接拒绝。)
api要保证输出结果的正确性(不管是正确的输出还是错误的输出接口内都可以进行处理)
api要保证输出的结果的一致性(同样的输入参数,多次输出结果是相同)
2.为什么使用契约原则规定接口?
提前告知api的相关约束减少不必要的沟通成本。
契约原则强迫你去思考是否满足更好的独立性。
契约原则强迫你去思考是否满足api的高可用。
3.如何做好api的接口设计?
接口的职责分离(最好每一个接口只做一个职责)
api的命名很重要(1.英文缩写的命名2.见名知义3.使用常用的缩写)
尽量少的创建自定义的错误码
同一接口要做到幂等性(第四问有解释)
使用安全策略(对于一些关键的接口要进行足够的安全加固和安全参数的验证)
使用版本管理(在更新接口的时候,可以使用v1和v2两种版本进行维护,也会带来更多的成本)
4.如何做到幂等?
使用天然幂等的操作原则
使用唯一键值
使用加锁策略
使用source+token验证机制
使用有限的转态机
什么是契约原则?
最新推荐文章于 2024-04-29 09:19:10 发布