提供给外部调用的接口设计原则


1、接口入参、出参和接口名应拥有统一的命名规范,要做到见名知意。

2、不要做大而全的接口,要尽量保持接口的功能单一

好处:这样有利于接口调试、改造升级和维护

3、接口出参应含有接口调用结果信息(code 和 message)字段
4、接口出参应对同类型(单条,多条,分页)的数据有固定相同的格式

 好处:3和4条 可以方便接口使用者封装接口的调用

5、接口出参要使用像json或xml这种平台无关的数据格式
好处:json和xml使接口也具有了良好的跨平台特性

    json与js的完美融合,更利于前端开发


该接口设计原则针对webservice接口和fix接口

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值