14.app后端如何设计api

app和后端的交互，一般都是通过后端提供的api实现。api的设计，估计很多刚进入app后端的小伙伴会一无头绪，不知道怎么入门。下面根据自己3年的app后端经验，总结出下几个api设计原则，给小伙伴参考。

1. 什么是api？

　　这个问题在以前发表的文章“7.app和app后端的通讯”中其实已经回答了，这里再重复一次。


　　相信大家都用过银行的柜员机(ATM)的查询余额，转帐，取款等操作。


　　当在柜员机取款的时候，我们输入要取款的金额，隔一会钱就出来了，如果因为有什么问题不能取款（例如超过取款金额的限制），屏幕上也会显示出错误的信息。


　　在整个过程中，我们只要输入金额，获得结果（取款成功或不成功），就行了，至于柜员机内部是怎么处理，我们不需要理会。


　　柜员机这种把内部的处理遮蔽的做法极大方便了我们的使用。


　　同样的，在后端，也只提供了一系列的功能给app使用，这系列的功能以api的形式提供。


　　api的定义：API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。


　　当app调用api的时候，只需要明确下面３点:


　　1.这个api是干啥的（柜员机例子中，是取款功能，还是查询余额,还是转账）


　　2.知道要输入什么（柜员机例子中，取款要输入金钱）


　　3.知道结果是什么（柜员机例子中，取款是成功还是失败）


　　至于api内部是怎么处理的，app根本无需理会。


　　从这里可看出，api能在最大程度遮蔽了app后端复杂性，极大提高了app前端的开发效率。

2. api设计的8点

　　 (1)Restful设计原则


　　Restful风格：RESTfu设计原则,它被Roy Felding提出（在他的”基于网络的软件架构“论文中第五章）。而REST的核心原则是将你的API拆分为逻辑上的资源。这些资源通过http被操作（GET ,POST,PUT,DELETE）。


　　在实际的开发过程中发现，程序员由于在web端养成的习惯，api操作中通常就只有两种方式"POST""GET"。大家可看一下微博的api例子"statuses/destroy"，这个很明显是delete操作的api却是用post方式提交。不是完全遵守Restful风格的风格。


　　这个设计原则最简单的应用就是根据object而不是页面来设计api。最开始的时候，app的一个页面需要什么数据，api就返回什么数据。结果随着app的UI不断改版，需要的数据不断变化，不停地修改api，最后当api的改动会影响以前的版本的时候，只能写一个新的api版本，最后弄得api中有很多V2,V3这样的标志，恶梦!


　　后来在网站的重构过程中，就根据object来设计api，但根据object来设计，又有一个问题，一个大object可能包含很多小object，是一个api返回全部小object，还是分为多个api返回？根据业务和技术，带宽等仔细考虑吧。


　　 (2) api的命名


　　一看api名字就知道这个api是干啥。在创业团队中，一般就只有一两个人负责后台，当你要负责几十甚至上百个api，你就知道不能“望名