本文介绍了App后端API设计的原则，包括RESTful风格，命名规范，安全性，数据处理，图片处理策略，返回提示信息以及在线API文档和测试。强调了根据对象设计API以避免频繁修改，以及如何处理空值和图片尺寸适应。同时提倡服务端返回信息代码而非具体文字，以区分用户提示和程序员提示，并分享了在线API测试文档的便利性。
(1)Restful设计原则
Restful风格：RESTfu设计原则,它被Roy Felding提出（在他的”基于网络的软件架构“论文中第五章）。而REST的核心原则是将你的API拆分为逻辑上的资源。这些资源通过http被操作（GET ,POST,PUT,DELETE）。
但现在看，一般的操作只有两种：GET ,POST。
这个设计原则最简单的应用就是根据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，你就知道不能“望名知api”是个什么样的痛苦。
(3) 安全性，请看
最低0.47元/天 解锁文章
扫一扫
1245
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
