APP开发实战8-API接口设计

接口设计

(1)需要确定APP和服务器间用什么格式传输数据,常用的有两种:XML和Json。XML文件中存在大量的描述信息,会大大增加网络传输数据;同样的内容,用Json格式,传输的数据比较少,首选Json格式。

还有一种Protocol Buffers格式,以二进制的方式传输存储数据,网络传输数据量比Json还少,但要使用proto文件作为格式验证,各语言需要整一堆pb runtime以及对应的代码生成,增加复杂度较高,目前使用的不多。

(2)需要设计Json数据的具体格式:

发送请求(无具体参数)

发送请求(有非数组格式的具体参数)

发送请求(有数组格式的具体参数)

操作成功(只返回操作状态,不返回数据)

操作成功(返回操作状态和非数组数据)

操作成功(返回操作状态和数组数据)

操作失败(只返回操作状态和出错提示)

在定义Json中的字段名称时,尽量短小,以减少网络传输数据。

(3)APP端解析Json格式时,最好采用严格模式,只要从服务器传来的Json数据,和约定的不一致,无论是多字段、少字段还是字段名称变了,APP端都应报错,这样有利于早发现问题。

(4)因为服务器端的接口代码可能会发生变化,所以在APP端向服务器端发送请求时,最好把接口的版本号也带上。

如已经上线的旧APP中使用的接口版本是1.0,在上线后接口更新到1.1版本,而且不兼容1.0版本,用户有可能不更新APP,还是使用旧版本APP。

服务器端接收到请求后,发现APP使用的接口版本是1.0,就可以调用旧接口处理APP请求;如果请求中不带版本号,遇到这种状况,就很难处理了。

(5)APP往往需要从服务器获取图片,但服务器的图片往往不完全适合APP需要,就需要先在服务器端按APP的需要处理图片,然后把处理过的图片传给APP; APP在发送获取图片的请求时,把所需图片的宽度和高度发给服务器,如采用GET命令,可以按以下方式:

http://www.hello.com/getimage/2/width/100/hight/100

服务器收到请求,就可按APP要求的尺寸处理图片,并发给APP。

(当然也可以用POST命令实现)

(6)大多数APP和服务器交互时用HTTP协议,也就是短连接:每向服务器发送一个请求都要先建立连接,传输数据,然后再断开连接;即使服务器端有做连接池设计,但连接池中容纳的连接个数有限制。

在设计接口时,在APP端执行的每一个动作,尽量做到只需向服务器发送一次请求;也要减少APP在显示新页面时,发送请求的次数,以减少APP和服务器建立连接和断开连接消耗的时间及资源,提高程序响应速度。

(7)对于向APP返回数组数据的接口应设计支持分页操作,提供参数供APP端设置获取元素的起始位置和获取的个数:

数组中有100个元素,但APP端可能第一次从第1个元素开始只获取10个元素,第二次从第11各元素开始只获取5个元素。

如电商APP中获取商品列表和订单列表等就需要这样设计。

(8)服务器端采用的语言即有Java这样的强类型语言,也有PHP这样的弱类型语言,有些后台同事很喜欢使用字符串类型,导致APP端常会遇到类型出错的问题,本来需要整型数据,结果服务器传的是字符串。

为解决这类问题,在和服务器端定义字段的数据类型时,除了在APP端会涉及到数学的加、减、乘、除或比较大小运算的字段外,其余的字段都定义成字符串类型;或把所有字段都定义成字符串,APP内部把字符串转换成整型或浮点型。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,670评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,928评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,926评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,238评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,112评论 4 356
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,138评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,545评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,232评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,496评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,596评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,369评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,226评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,600评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,906评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,185评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,516评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,721评论 2 335

推荐阅读更多精彩内容