提供给外部调用的接口设计原则
2017-02-13 22:02
866 查看
1、接口入参、出参和接口名应拥有统一的命名规范,要做到见名知意。
2、不要做大而全的接口,要尽量保持接口的功能单一
好处:这样有利于接口调试、改造升级和维护
3、接口出参应含有接口调用结果信息(code 和 message)字段
4、接口出参应对同类型(单条,多条,分页)的数据有固定相同的格式
好处:3和4条 可以方便接口使用者封装接口的调用
5、接口出参要使用像json或xml这种平台无关的数据格式
好处:json和xml使接口也具有了良好的跨平台特性
json与js的完美融合,更利于前端开发
该接口设计原则针对webservice接口和fix接口
2、不要做大而全的接口,要尽量保持接口的功能单一
好处:这样有利于接口调试、改造升级和维护
3、接口出参应含有接口调用结果信息(code 和 message)字段
4、接口出参应对同类型(单条,多条,分页)的数据有固定相同的格式
好处:3和4条 可以方便接口使用者封装接口的调用
5、接口出参要使用像json或xml这种平台无关的数据格式
好处:json和xml使接口也具有了良好的跨平台特性
json与js的完美融合,更利于前端开发
该接口设计原则针对webservice接口和fix接口
相关文章推荐
- 提供一个在测试环境中,监控应用服务器的外部接口调用的方法(高峰)
- VB.NET封装控件后提供给外部调用接口
- 提供一个在测试环境中,监控应用服务器的外部接口调用的方法(高峰)
- webservice实际应用之调用外部系统提供的服务端地址,写java的webservice客户端程序并通过接口给外部系统传数据
- 提供一个在测试环境中,监控应用服务器的外部接口调用的方法(高峰)
- 解析SOA十大设计原则 公共接口与内部实现要明确界限
- C#调用VC dll提供的接口
- 小谈子对象中接口的设计原则
- SOA十大设计原则 公共接口要明确界限
- COM 组件设计与应用(十一)---IDispatch 及双接口的调用
- C++类和接口的设计原则探讨
- 面向对象设计三大原则(封装变化点,对接口进行编程,多使用组合而不是继承)
- 解析soa十大设计原则 公共接口要明确界限 (1)
- 模块间接口设计的原则
- C++类和接口的设计原则
- 小谈子对象中接口的设计原则
- 小谈子对象中接口的设计原则
- 接口调用定律与测试驱动接口设计
- 抽象类和接口在语法和设计原则上的区别
- 独家:SOA十大设计原则 公共接口与内部实现要有明确界限