APP社交类项目(类微信)设计之二前后台API介绍

本文分享了关于APP社交类项目(类似微信)的后端API设计经验,包括API的基本概念、设计原则如Restful风格、命名规范、安全性、返回数据处理、图片处理策略、错误信息、在线测试文档和API版本升级的注意事项。旨在帮助开发者提高API设计效率和客户端的开发体验。

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

1. 什么是api?


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


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


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


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


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


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


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


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


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


  2.知道要输入什么(柜员机例子中,取款要输入金钱)


  3.知道结果是什么(柜员机例子中,取款是成功还是失败)


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


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

2. api设计的8点


  <

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符  | 博主筛选后可见
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

三翔馆主

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值