怎么设计一个好的接口(一)

之前有面试官问我:怎么设计一个好的接口

结合工作实际做记录:

1.昨天遇到一个接口,入参给了一个售后单id,查询售后单详细,接口内部还需要根据这个id去调调用方查询这个售后单id是哪供应商的,解读这个接口是:给了一个不知道是哪个供应商的售后单id来查询售后单详细,很奇怪不?参数不明确

定义的参数要明确,能让人看懂,你这个接口是干嘛的,这个接口可以加上一个参数,供应商code,就可以解读为:查询某某的供应商的售后单id为某某的售后单详细

2.接口要遵循业务单一职责,特别是基础服务接口,对外的聚合接口可以有一定的业务耦合

3.接口从命名到参数,能看出明确的含义,包括参数,即看到接口,你能看出这个接口干啥的

4.参数和功能最小功能原则,接口不能暴露和处理除了业务外的其他信息

5.命名规范

猜你喜欢

转载自blog.csdn.net/xuanfuhuo4769/article/details/81478107