查看原文
其他

国博史上首次收藏代码!代码的 URL 设计还没遵循RESTful API 风格?

非杠精纯交流 JavaGuide 2022-03-15

阿里抗疫代码入藏国博

中国国家博物馆又要上新了。最新入藏中国国家博物馆的藏品是阿里抗疫的 30 件物资,包括抗疫期阿里程序员们写的代码。这也是国博历史上首次收藏代码。

真给程序员长脸!

中国国家博物馆向阿里巴巴集团、蚂蚁集团,阿里巴巴公益基金会和马云公益基金会颁发“援助抗击新冠疫情实物捐赠证书”。

在这份捐赠清单中,让人眼前一亮是三个“第一行代码”:支付宝团队研发的健康码系统第一行代码;阿里云研发的全国健康码引擎第一行代码;阿里巴巴达摩院研发的新冠肺炎 CT 影像 AI 辅助诊断产品第一行代码。

这是中国国家博物馆历史上第一次收藏代码。这三行代码下面,是 42 名写代码的阿里程序员的签名,阿里云的程序员们还附上了个人头像。

题外话(非杠)

我们来仔细看一下这段代码哈,非杠精。

这段Controller代码的 URL 设计貌似和常规的 RESTful API 约定不太一样。

  1. RESTful API 风格规定不用大写字母,建议用中杠 - 不用下杠 _ 比如邀请码写成 invitation-code 而不是 invitation_code
  2. RESTful API 风格规定网址中不能有动词,只能有名词,API 中的名词也应该使用复数。 因为 REST 中的资源往往和数据库中的表对应,而数据库中的表都是同种记录的"集合"(collection)。如果 API 调用并不涉及资源(如计算,翻译等操作)的话,可以用动词。 比如:GET /calculate?param1=11&param2=33

其实也不用太纠结,我这里只是随口一说。只要团队达成一致就好,我们程序员都是很好说话很友善的一群人嘛!

这段代码后面可能也被重构成了 RESTful 风格。怎么说呢? 如有可能,就尽量准守 RESTful API 风格吧。有一些项目没有准守 RESTful API 风格可能是项目历史遗留问题比如修改成本比较大或者说项目成员达成了共识不遵守 RESTful API 风格。

不过,还是建议大家尽量能遵守比较好的实践,你可以阅读我的这两篇原创文章(强烈推荐!):

  1. 避免自己写的 url 被 diss!建议看看这篇 RestFul API 简明教程!
  2. 因为命名 Guide 被 diss 无数次。简单聊聊编程最头疼的事情之一:命名

闲聊

我平时是一个特别喜欢记录的人,我遇到的好文章,看过的好书,学习过的好专栏,我都会记录下来,记录自己的所得所获。

Typora+Github同步是我目前记笔记的方式。不知道适不适合别人,反正目前来看这种方式我最喜欢。

简单给大家看一下我的笔记分类目录吧(挺杂的,最近会优化目录):

上周日和我们大学的传奇人物,研究生在华科,目前在华为的学长聊了一会。收获确实不少,果然优秀的人总有一些过人的地方(这周应该会把自己的所得所获分享出来)。

最近更新的一些文章推荐:


往期推荐



你见过最烂的Java代码长什么样子?

被喷了?聊聊我开源RPC框架的那些事

我利用业余时间通过技术写作挣了3个顶配Mac Pro

工作中巧用了这几个设计模式重构代码,女同事直呼666

我在蚂蚁外包的这段时光

和一位阿里的小姐姐聊了聊“面试造火箭,工作拧螺丝钉”这个现象


我整理的4本PDF文档,公众号“后端技术进阶”后台回复“面试突击”即可免费获取。

文章有帮助可以点个「在看」或「分享」,都是支持,我都喜欢!

我是Guide哥,Java后端开发,会一点前端知识,喜欢烹饪,自由的少年。一个三观比主角还正的技术人。我们下期再见!


您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存