/{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动词有下面五个(括号里是对应的SQL命令):
-
GET(SELECT):从服务器获取资源(一项或多项),例:GET /users(获取所有用户)
-
POST(CREATE):在服务器新建一个新的资源,例:POST /users(创建用户)
-
PUT(UPDATE):在服务器更新资源(客户端提供更新后的完整资源),例:PUT /users/12(更新编号为 12 的用户)
-
PATCH(UPDATE):在服务器更新资源(客户端提供更新的属性,可以看作是部分更新,使用较少),例:
-
DELETE(DELETE):从服务器删除资源,例:DELETE /users/12(删除编号为 12 的用户)
示例:
GET /users:列出所有的用户(列表信息)
GET /users/ID:获取某个指定的单个用户的信息
POST /users:创建一个新用户
PUT /users/ID:更新某个指定用户的信息(提供该用户的全部信息)
PATCH /users/ID:更新某个指定用户的信息(提供该用户的部分信息)
DELETE /users/ID:删除某个用户
复杂资源关系的表达
GET /depts/ID/users:列出某个指定部门的所有用户
DELETE /depts/ID/users/ID:删除某个指定部门的指定用户
GET /cars/711/drivers 返回使用过编号711汽车的所有司机
GET /cars/711/drivers/4 返回使用过编号711汽车的4号司机
在谈及GET,POST,PUT,DELETE的时候,就必须提一下接口的安全性和幂等性,其中安全性是指方法不会修改资源状态,即读的为安全的,写的操作为非安全的。而幂等性的意思是操作一次和操作多次的最终效果相同,客户端重复调用也只返回同一个结果。
上述四个HTTP请求方法的安全性和幂等性如下:
如果记录数量很多,服务器不应该都将它们全部返回给用户。此时API应该提供参数,过滤返回结果,比如:
users?limit=10:指定返回记录的数量
users?offset=10:指定返回记录的开始位置。
users?pageNum=2&pageSize=100:指定第几页,以及每页的记录数。
users?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
users?animal_type_id=1:指定筛选条件
参数的设计允许存在冗余,即允许API路径和URL参数偶尔有重复。比如,GET /depts/ID/users
与 GET /users?depts_id=ID
的含义是相同的。
针对不同操作,服务器向用户返回的结果应该符合以下规范。比如:
-
GET /collection:返回资源对象的列表(数组)
-
GET /collection/resource:返回单个资源对象
-
POST /collection:返回新生成的资源对象
-
PUT /collection/resource:返回完整的资源对象
-
PATCH /collection/resource:返回完整的资源对象
-
DELETE /collection/resource:返回一个空文档
示例
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数前端工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Web前端开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上前端开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:前端)
![](https://i-blog.csdnimg.cn/blog_migrate/3113de9b259041973b3c009bb790c89e.jpeg)
最后的最后
面试题千万不要死记,一定要自己理解,用自己的方式表达出来,在这里预祝各位成功拿下自己心仪的offer。
需要完整面试题的朋友可以点击蓝色字体免费获取
来,在这里预祝各位成功拿下自己心仪的offer。
需要完整面试题的朋友可以点击蓝色字体免费获取
[外链图片转存中…(img-afHbhO6z-1712203526433)]
[外链图片转存中…(img-A1zXbXCj-1712203526433)]
[外链图片转存中…(img-NM9CyRrc-1712203526433)]
[外链图片转存中…(img-TXdT0M3q-1712203526434)]