http接口调用时注意事项

哎呀呀,今天本来都准备上线了,结果发现了一个小bug(不影响主流程的那种),是由于三方接口返回不明确引起的。主要的问题就是http接口对方返回的是null,而我没有判空。当我判空后,又发现,妈的格式又和约定好的不一样,有个关键success字段居然是空的。。。( ̄▽ ̄)||
然后针对今天的问题,老大叫我去讨论了下,并且传授了一份在调用http接口时常见的注意事项。

接口编程(请求方)

接口调用常见流程

  • 请求参数合法校验
  • 打印/记录请求报文(日志和数据库)
  • 调用
  • 网络相关异常处理
    网络连接异常
    网络超时/合理设置超时时间
    其它未知异常
  • 打印/记录返回报文
  • 报文格式校验
  • 报文解析(解析也可以作为格式校验的一部分)
  • 报文参数校验(格式、取值范围等)

接口调用切记

  • 不打印/记录请求返回报文,给调试和排查问题带来很大麻烦
  • 不处理网络相关异常,程序不够健壮
  • try/catch大量代码,错误提示不友好、让后续维护的人没有安全感
  • 请求和返回参数校验不充分,程序不够健壮
  • 没有设计错误码/大量未知错误码
  • 报文记录时:不能等获得返回报文时再和请求报文一起记录,需要分别开新事物记录到数据库中

一定要注意设置合理的超时时间!以前做过一个很坑的项目,一个接口需要我设置5分钟的超时时间,后来商量着让对方改为异步的了,后续回调通知结果。
以上是是针对请求方的,如果以后最为提供方的话。

注意点

  • 接口文档一定要写详细,每个字段的类型,是否必传,枚举说明,字段的长度。
  • 对于关键的返回值,比如状态字段,一定要约定好,不能随意增减。
  • 接口地址一般前缀都会加上版本/v1/xxx之类的
  • 接口升级时,请一定要注意对以往版本的兼容(/(ㄒoㄒ)/~~特别是新增字段这种,不要出现由于以往版本由于字段无法识别导致错误的情况)
  • 接口要精简,不要传无用字段
  • 对于处理时间很长的接口,采用回调通知结果的方式
  • 一定要记录接口的调用(request,response)情况(同上)
  • 对每个接口的调用方要以渠道号区分,每个渠道使用不同的密钥
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,463评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,868评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,213评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,666评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,759评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,725评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,716评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,484评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,928评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,233评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,393评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,073评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,718评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,308评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,538评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,338评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,260评论 2 352

推荐阅读更多精彩内容