Restful API 设计规范，算法真题解析：美团+Tencent+字节跳动+阿里+360+拼多多

最新推荐文章于 2024-10-14 11:26:48 发布

m0_60707538

最新推荐文章于 2024-10-14 11:26:48 发布

阅读量969

点赞数 28

分类专栏： 2024年前端程序员文章标签： restful 设计规范算法

本文链接：https://blog.csdn.net/m0_60707538/article/details/136845751

版权

2024年前端程序员专栏收录该内容

8 篇文章 0 订阅

订阅专栏

看http method就知道针对资源干什么
看http status code就知道结果如何

URL设计规范

URL是统一资源定位器 ,通常一个完整的URL组成由以下几个部分构成：

scheme “😕/” host “:” port “/” path [ “?” query ][ “#” fragment ]

其中：

scheme: 指底层用的协议，如http、https、ftp
host: 服务器的IP地址或者域名
port: 端口，http默认为80端口
path: 访问资源的路径，就是各种web 框架中定义的route路由
query: 查询字符串，为发送给服务器的参数，在这里更多发送数据分页、排序等参数。
fragment: 锚点，定位到页面的资源

在设计API时URL的path是需要认真考虑的，而RESTful对path的设计做了一些规范，通常一个RESTful API的path组成如下：

/{version}/{resources}/{resource_id}

其中：

version：API版本号，有些版本号放置在头信息中也可以，通过控制版本号有利于应用迭代。
resources：资源，RESTful API推荐用小写英文单词的复数形式。
resource_id：资源的id，访问或操作该资源。

当然，有时候可能资源级别较大，其下还可细分很多子资源也可以灵活设计URL的path，例如：

/{version}/{resources}/{resource_id}/{subresources}/{subresource_id}

此外，有时可能增删改查无法满足业务要求，可以在URL末尾加上action，例如：

/{version}/{resources}/{resource_id}/action

其中action就是对资源的操作。

RESTful API的URL具体设计的规范如下：

不用大写字母，所有单词使用英文且小写
连字符用中杠"-“来提高URI的可读性，而不用下杠”_"
正确使用 "/"表示层级关系，URL的层级不要过深，并且越靠前的层级应该相对越稳定
结尾不要包含正斜杠分隔符"/"
URL中不出现动词，用请求方式表示动作
资源表示用复数不要用单数
不要使用文件扩展名

版本

应该将API的版本号放入URL中，不要发布无版本的API，比如：

https://api.hcshow.com/v1/

面向扩展开放，面向修改关闭：也就是说一个版本的接口开发完成测试上线之后，我们一般不会对接口进行修改，如果有新的需求就开发新的接口进行功能扩展。这样做的目的是：当你的新接口上线后，不会影响使用老接口的用户。如果新接口目的是替换老接口，也不要在v1版本原接口上修改，而是开发v2版本接口，并声明v1接口废弃！

路径

在RESTful架构中，每个网址代表一种资源（resource），所有网址请求接口中不能有动词，只能有名词，这些名词往往与数据库的表格名对应，应该使用复数。示例：

https://api.hcshow.com/v1/users

https://api.hcshow.com/v2/articles

HTTP动词

对于资源的具体操作类型，由HTTP动词表示。常用的HTTP动词有下面五个（括号里是对应的SQL命令）:

GET（SELECT）：从服务器获取资源（一项或多项），例：GET /users（获取所有用户）
POST（CREATE）：在服务器新建一个新的资源，例：POST /users（创建用户）
PUT（UPDATE）：在服务器更新资源（客户端提供更新后的完整资源），例：PUT /users/12（更新编号为 12 的用户）
PATCH（UPDATE）：在服务器更新资源（客户端提供更新的属性，可以看作是部分更新，使用较少），例：
DELETE（DELETE）：从服务器删除资源，例：DELETE /users/12（删除编号为 12 的用户）

在这里插入图片描述

小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级前端工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！
因此收集整理了一份《2024年Web前端开发全套学习资料》送给大家，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频

如果你觉得这些内容对你有帮助，可以添加下面V无偿领取！（备注：前端）

Vue 面试题

1.Vue 双向绑定原理
2.描述下 vue 从初始化页面–修改数据–刷新页面 UI 的过程？
3.你是如何理解 Vue 的响应式系统的?
4.虚拟 DOM 实现原理
5.既然 Vue 通过数据劫持可以精准探测数据变化,为什么还需要虚拟 DOM 进行 diff 检测差异?
6.Vue 中 key 值的作用？
7.Vue 的生命周期
8.Vue 组件间通信有哪些方式?
9.watch、methods 和 computed 的区别?
10.vue 中怎么重置 data?
11.组件中写 name 选项有什么作用？
12.vue-router 有哪些钩子函数?
13.route 和 router 的区别是什么？
14.说一下 Vue 和 React 的认识，做一个简单的对比
15.Vue 的 nextTick 的原理是什么？
16.Vuex 有哪几种属性?
17.vue 首屏加载优化
18.Vue 3.0 有没有过了解？
19.vue-cli 替我们做了哪些工作？
…