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

前端之家收集整理的这篇文章主要介绍了提供给外部调用的接口设计原则前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。


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

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

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

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

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

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

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


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

猜你在找的WebService相关文章