用node建立web服务(七)研究接口标准

前后端通讯,必须先确定接口,那么这个接口要如何确定呢?

随意阶段

一开始也没啥规范标准,都是根据自己的习惯喜欢,系统功能的情况来制定,基本上是怎么方便怎么来。

基本的方式是按照“动作”来定义,比如 addUser、updateUser 这类的。

RESTful

有个老外看不下去了,倡导一种统一的接口风格。
大体的意思就是,先定义一种资源,比如用户,然后定义一组动作,就是增删改查。然后还有一些code建议等等风格。

于是就变成了这样:

【get】user/10 // 获取用户
【post】user // 添加用户
【put】user/10 // 修改用户
【delete】user/10 // 删除用户

话说,查询怎么表示来着?

这种方式看起来挺好,但是实践的时候就会遇到各种问题,于是你就会发现,原本开会讨论的是功能如何实现,分工如何来做,变成了讨论怎么起名才能够符合这种风格。

比如用户登录,以前可以叫做 login,那么现在要如何做呢?

【get】userOnline // 验证用户是否登录
【post】userOnline // 登录,在线用户 + 1
【delete】userOnline // 退出,在线用户 - 1

好像还可以解决。

那么如何区分物理删除、逻辑删除呢?只有一个【delete】。
或者说不需要区分了,后端自己决定?还是一刀切?

还有常见的订单,

  • 生成订单
  • 未付款/已付款
  • 商家发货
  • 物流运输
  • 卖价收货

这些状态涉及三方:商家、物流、买家,这个要如何区分?还是说统统都用【put】,然后加参数识别?

想想都头疼。

还有各种不常见的功能和需求。为了符合这种风格,是不是有点太累了?

GraphQL

这种方式挺好的,但是有一点没弄明白,为啥需要前端提交一个数据结构的说明?
这是不是有点折腾呀,把这种需求说明,事先约定好,然后直接在后端保存下来不香吗?
然后制定一个编号,前端要用的时候,直接提交这个编号即可,后端获得编号,然后加载具体需求,这样是不是更便捷?
还安全,不用担心前端瞎提交结构。

到底要如何指定接口?

既然都有不足的地方,那么能不能综合一下,把优点留下,不足去掉呢?

我们可以大胆尝试一下:

  • 名称方面不限制名词还是动词,合理即可
  • 结构说明放在后端,前端提交对应的编号即可
  • 动作可以参考使用。
  • 其他待定

关于动作

这个有点纠结,可以使用,但是又不想一刀切的使用,如果设计成两类情况,一类情况需要用,另一类情况不需要用,那么这个是不是有点混乱?

其实,对于简单的增删改查,这种方式确实挺简洁的,但是复杂的就不适合了。

还有就是,似乎不是所有的前端环境都支持这些个动作,get、post肯定支持,但是其他的就不一定了。

还有,前端不仅仅是浏览器,还包括各种APP。万一有哪个环节就是不支持,怎么办?

初步设想

【模块ID】【动作ID】-【名称】

比如:

【post】10010 - addUser
【post】10020 - updateUser
【get】 10030 - deleteUser/:id
【get】 10040 - getUser/:id
【post】10050 - findUser
  • 模块
    可以基于资源设置,也可以不用,总之合理即可

  • 动作
    包括且不限于 添加、修改、删除、查询。也不限制数量,可以有多个修改、多个删除。
    可以做个约定:

    • 10-19 表示添加类;
    • 20-29 表示修改类;
    • 30-39 表示删除类;
    • 40 表示依据ID获取一条记录
    • 50 表示查询和分页

这样数量就不受限制了。

  • 名称
    这个主要是为了可读性,其实可以不要。
    如果去掉这个名称的话也是可以运行了,只是看一堆数字,不知道是干啥的可读性比较差,有了这个名称就一目了然了。

  • method
    只需要get和post,其他的可以支持,但是不起作用。
    其实动作ID和这个 method 有些类似,区别在于,我可以随意定义动作ID,没有限制。而 method 有各种限制和制约。

这样应该差不多了。

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

推荐阅读更多精彩内容