接口设计的一些小总结

本文总结了在提供数据接口过程中遇到的问题及解决方案,强调了接口设计的三个核心原则:采用通用标准、保持接口最小化以及避免过多接口以减少不一致性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

最近时不时的需要给其他部门提供数据接口,遇到了些问题教训,总结一下:

1、接口尽量采用通用标准,如http接口;数据格式也是如此,如json。一个老系统使用了非标准json,如{code:0,total:10},导致最近在迁移系统时出现了兼容问题,给第三方也给自己带来了很大麻烦。

2、接口尽量保持最小化。比如提供页面pvuv数据,那么接口中就只要2个数据项即可,至于由此衍生出来的什么同比环比之类的数据,就不需要放入接口中了,第三方使用者可以根据需要自己去做计算。

3、接口不是越多越好。同样一个数据,如果存在多个不同的接口,有可能出现计算方式的不一致导致数据不一致;多个接口也带来维护上的麻烦。比如现在有了一个提供分钟级流量数据的接口,第三方如果需要半小时或一小时级别的数据,就不用再额外开发新接口,直接使用分钟级接口进行半小时或一小时汇总即可。

转载于:https://www.cnblogs.com/csbird/archive/2013/02/03/2891225.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值