免费下载案例集|20+数字化领先企业人才培养实践经验 了解详情
写点什么

公司前端历数后端研发接口 5 宗罪

  • 2020-04-23
  • 本文字数:1807 字

    阅读完需:约 6 分钟

公司前端历数后端研发接口5宗罪

前端和后端应该相亲相爱,当然是建立在“专业”的基础上。


  • 罪状一:没有文档

  • 罪状二:文档不全

  • 罪状三:接口参数没校验

  • 罪状四:没保证接口原子性

  • 罪状五:接口问题不断

  • 今天一位前端开发人员扯起了后端接口的皮,那个兄弟对后端人员提供的接口很大的意见(我是司空见惯),不过他说的也确实有道理,所以结合我的见解,希望提供接口的人员能多加注意。


罪状一:没有文档


例如新的前端人员到了一个新的公司,使用接口时,问这个这个不知道,问那个那个不知道,要文档没文档,这绝对是前端人员最抓狂的事,心里肯定是一千只草泥马奔腾而过。


1.为什么要文档?


文档是当前开发者甚至后面的接盘侠(后面开发者)能够清晰往下做的指引。


即便是简单的东西,但如果不写文档,以后口口相传消耗的工作量会比写文档更多。


好记性不如烂笔头,一段时候后,可能连开发者都忘记接口的用途。


2.文档怎么写?


在线文档。


在线文档易于更新和他人查看,例如可以使用 Swagger 编写接口文档。


PS:Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。


本地文档。


本地文档一般用 Word 文档,但是比较不易传播,但能离线查看。


Final~


文档是及其关键的,无论是在线文档还是本地文档,有是关键。虽然写文档是麻烦的事,但对后端人员来说,是利人利己。


罪状二:文档不全


额,就是有了文档,文档里面对接口的描述也可能不全,可能缺每个参数详尽描述(取值范围、类型)、请求方式(GET、POST、PUT、DELETE)、返回数据的所有状态等等。这里面可能最缺就是返回数据的状态!


一般的返回数据结构~


公司的数据接口返回结构是


{s : 0/ 1, //表示此操作的处理状态( status ),一般简单的成功 /不成功,使用 1/0 表示。m : 'xxxx', //表示此操作的提示信息( message ),一般只用来显示操作失败时提示信息。r : [], //表示此操作的返回值( result )count : x //返回的数据条数}
复制代码


这种数据结构看起来没问题,确实也没大问题,问题就是出在 s 这个字段。有许多的接口不仅仅只有两种状态,成功状态只有一种倒是没问题,问题就出在失败状态,失败可能有很多情况,一个简单的 s:0 不能说明失败的原因(即便是有 m 提示信息,但用这个来区分很不靠谱,因为提示可能会变化),我们不总是仅拿 m 做显示用。


升级返回数据结构~


那位同事建议以下方式应答


{s : 0/ 1/ 2/ 3, // 0代表正常,1是参数有误,2是用户不存在,3是用户没权限等等m : 'xxxx', //表示此操作的提示信息( message ),一般只用来显示操作失败时提示信息。r : [], //表示此操作的返回值( result )count : x //返回的数据条数}
复制代码


m、r、count 可以保持不变,但是 s 里面必须包含所有返回状态,代表这个接口所有业务的情况,前端开发人员也就能针对每种情况进行处理。


文档最重要的部分是返回值的状态,我也建议上面的升级返回数据结构,这样就不存在任何不明朗情况。既然写了文档,就把文档写好,写明朗,这也是利人利己地方。


罪状三:接口参数没校验


这个前端人员倒不是很关注,因为本身调接口之前都会先做校验,后端做参数校验只是双重保证。我之前也做过一段时间后端,也犯过没校验参数的错,额,因为后来没有做后端,也就没有去修正。不过还是提醒后端人员,做好参数校验是第一步,不要偷懒了。


统一处理好接口校验,后端好好考虑下。


罪状四:没保证接口原子性


接口的原子性很重要,有时一个接口可能会干几件事,但不一定都能正常完成,这就导致可能存在原子性问题,接口不能准确被调用。


PS:原子性。一个原子事务要么完整执行,要么干脆不执行。这意味着,工作单元中的每项任务都必须正确执行。如果有任一任务执行失败,则整个工作单元或事务就会被终止。即此前对数据所作的任何修改都将被撤销。如果所有任务都被成功执行,事务就会被提交,即对数据所作的修改将会是永久性的。


原子性一定要保证,保证,保证!


罪状五:接口问题不断


前端开发人员调接口时候,可能会存在各自各样的问题,有问题可以理解,程序哪会没有 bug,但不能太离谱啊,后端兄弟们。所以我觉得在给出接口之前自己明确几件事:


1.是否校验参数。


2.是否所有的情况都测试过了,如果可以请写单元测试。


3.是否返回数据准确明朗,响应状态码是否正常。


4.文档是否已经完备。

总结

后端人员多体谅前端人员,在出现问题时,先检查自身,别一上来就跟前端干起来,要是自己的问题就尴尬了。


本文转载自技术琐话公众号。


原文链接:https://mp.weixin.qq.com/s/LZ8bhkOQDjPzPF4t2sccPg


2020-04-23 17:38679

评论

发布
暂无评论
发现更多内容

33岁公司倒闭,被迫走上大龄Java程序员求职之路

Java架构师迁哥

Github上星标85k的,图解操作系统、网络、计算机 PDF,竟是阿里的?

Java架构师迁哥

架构实战营第三次作业

Geek_d18264

架构实战营

膜拜!“Java葵花宝典”脉脉一周狂转50w次,Github访问量破百万

Java架构师迁哥

阿里开源的面试全面解析,为什么会在Github一周标星63K?

Java架构师迁哥

双非渣本后端,三个月逆袭字节,入职那天“泪目”了

Java架构师迁哥

学生管理系统架构设计

guangbao

低代码平台J2PaaS即将发布开源版

J2PaaS低代码平台

低代码 开发工具 无代码

阿里P8近十年的开发经验总结,卖168元,你觉得贵吗?

Java架构师迁哥

Github上标星80k的笔记就是diao,一个月帮我斩获8家大厂offer

Java架构师迁哥

如何看待写作这件事

QualityFocus

个人成长 写作 写作感悟

微服务到底是什么?spring cloud在国内中小型公司能用起来吗?

Java架构师迁哥

白手起家之分布式搜索ES

卢卡多多

9月日更

一妹子揭露美团面试中一些不愉快的事情(Java岗)

Java架构师迁哥

知乎上线1小时,5w浏览量被下架的JVM全解笔记,内容太强大

Java架构师迁哥

学生管理系统详细架构设计

毛先生

算法有救了!GitHub上神仙项目手把手带你刷算法,Star数已破110k

Java架构师迁哥

学生管理系统架构设计方案

Nico

JVM类加载器学习笔记

风翱

JVM 9月日更

超24W字,2021最新一线大厂Java高级架构师面试题总结,共计480页

Java架构师迁哥

网络攻防学习笔记 Day138

穿过生命散发芬芳

无线网络安全 9月日更

天猫“618”亿级高并发设计实战手册,限时分享

Java架构师迁哥

pymssql

IT蜗壳-Tango

9月日更

覆盖80%以上Java性能调优场景,三年开发经验以下慎入

Java架构师迁哥

阿里内部不外传的50万字Java面试手册,首次开放,一天遭狂转10w次

Java架构师迁哥

双非渣本后端,三个月逆袭字节,入职那天“泪目”了

Java架构师迁哥

【MySQL技术专题】这也许是你的知识盲区->[主从架构]的多种同步模式

洛神灬殇

主从同步 高可用架构 MySQL 数据库 9月日更

汽车行业的进化秘诀,竟在这座智慧出行乐园中……

白洞计划

学生管理系统详细架构设计文档

消失的子弹

大数据 云原生 CMS

linux之rename命令

入门小站

Linux

在线JSON转flow工具

入门小站

工具

公司前端历数后端研发接口5宗罪_文化 & 方法_技术琐话_InfoQ精选文章