后端开发必备的 RestFul API 知识

RestFul API 是每个程序员都应该了解并掌握的基本知识,我们在开发过程中设计API的时候也应该至少要满足RestFul API的最基本的要求(比如接口中尽量使用名词,使用POST 请求创建资源,DELETE请求删除资源等等,示例:GET /notes/id:获取某个指定id的笔记的信息)。最近学习过程中接触到这些东西,自己没有时间总结,所以分享一些不错的文章给大家。

相关阅读:

•http://www.ruanyifeng.com/blog/2014/05/restful_api.html(阮一峰,这篇文章大部分内容来源)

•https://www.baeldung.com/spring-hateoas-tutorial(RestFul API Tutorial)

•https://aisensiy.github.io/2017/06/04/spring-boot-and-hateoas/(Spring中使用HATEOAS)

•https://spring.io/guides/tutorials/bookmarks/(Building REST services with Spring)

•https://www.baeldung.com/spring-hateoas-tutorial(https://www.baeldung.com/spring-hateoas-tutorial)

备注:HATEOAS这个大家可能之前并没有怎么接触过,我看了很多项目的源码也并没有满足HATEOAS设计的要求,实际上RestFul API 最好满足HATEOAS设计,也就是在返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。

一、重要概念:

REST,即Representational State Transfer的缩写,翻译过来就是"表现层状态转化"。

Resource(资源) :对象的单个实例。例如,一只动物。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实在。你可以用一个URI(统一资源定位符)指向它,每种资源对应一个特定的URI。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或独一无二的识别符。

集合:对象的集合。例如,动物。

第三方:使用我们接口的开发者

表现层(Representation):"资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式,叫做它的"表现层"(Representation)。

状态转化(State Transfer)访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。互联网通信协议HTTP协议,是一个无状态协议。这意味着,所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生"状态转化"(State Transfer)。而这种转化是建立在表现层之上的,所以就是"表现层状态转化"。

综合上面的解释,我们总结一下什么是RESTful架构:

(1)每一个URI代表一种资源;

(2)客户端和服务器之间,传递这种资源的某种表现层;

(3)客户端通过HTTP动词(GET,POST等等),对服务器端资源进行操作,实现"表现层状态转化"。

二、REST接口规范

1、动作

GET (SELECT):从服务器检索特定资源,或资源列表。

POST (CREATE):在服务器上创建一个新的资源。

PUT (UPDATE):更新服务器上的资源(客户端提供更新后的整个资源)。

PATCH (UPDATE):更新服务器上的资源(客户端提供更改的属性,可以看做作是部分更新)。

DELETE (DELETE):从服务器删除资源。

2、路径(接口命名)

路径又称"终点"(endpoint),表示API的具体网址。

在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。

举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。

接口尽量使用名词,禁止使用动词,下面是一些例子。

反例:

再比如,某个URI是/posts/show/1,其中show是动词,这个URI就设计错了,正确的写法应该是/posts/1,然后用GET方法表示show。

如果某些动作是HTTP动词表示不了的,你就应该把动作做成一种资源。比如网上汇款,从账户1向账户2汇款500元,错误的URI是:

POST /accounts/1/transfer/500/to/2

正确的写法是把动词transfer改成名词transaction,资源不能是动词,但是可以是一种服务:

POST /transaction HTTP/1.1

Host: 127.0.0.1

from=1&to=2&amount=500.00

理清资源的层次结构,比如业务针对的范围是学校,那么学校会是一级资源(/school),老师(/school/teachers),学生(/school/students)就是二级资源。

3、版本(Versioning)

应该将API的版本号放入URL。如:

另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github采用这种做法。

4、过滤信息(Filtering)

如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。下面是一些常见的参数。

5、状态码(Status Codes)

状态码范围

服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。

三 HATEOAS

上面是RESTful API最基本的东西,也是我们平时开发过程中最容易实践到的。实际上,RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。

上面代码表示,文档中有一个link属性,用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系(collection关系,并给出该collection的网址),href表示API的路径,title表示API的标题,type表示返回类型Hypermedia API的设计被称为HATEOAS。

在Spring 中有一个叫做HATEOAS的API 库,通过它我们可以更轻松的创建除符合 HATEOAS 设计的API。

-END-

看完本文有收获?请转发分享给更多人

关注「java程序媛之家」,提升Java技能

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20190806A0A27R00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。

扫码关注云+社区

领取腾讯云代金券

年度创作总结 领取年终奖励