原则:
-
命名知其意。
一看api名字就知道这个api是干啥。
-
api返回数据禁止null
-
服务器动态处理原图(如 60x60 、80x80)。
例如,客户端需要图片(http://www.baidu.com/img/bdlogo.gif)的80*80的尺寸,则在图片的路径加上宽和高的参数(类似于CDN的机制) http://www.baidu.com/img/bdlogo.gif?w=80&h=80, 则服务器就生成80*80的尺寸并返回。
-
最科学的情况,服务端只返回信息代码,具体的文字提示由客户端决定。
-
在线文档和api测试
我们网站的api在线测试文档,既是一份在线api文档,也是一个在线测试工具,极大方便沟通和测试。
原文:http://blog.csdn.net/newjueqi/article/details/14053733