Restful levels层级 和HATEOAS原则
Restful levels:
要知道API的哪个级别,Richardson引入了一个名为Richardson Maturity Model的模型。正如名称本身所暗示的,它讲述了REST API的成熟度级别。
根据Richardson成熟度模型,任何REST API都属于从0级到3级的任何成熟度级别,如下所述。
开发的每个REST API都不必高达3级。但是这个模型可以帮助REST API的开发人员知道他们的API属于哪个级别,以及如何通过在上面的模型层次结构中向上移动来改善他们的API 。
0级:POX的沼泽
- 在此级别设计的API根本不是Rest API,而是基于SOAP的Web服务发生的地方。
- 在此级别,没有基于资源的URI, 超媒体的概念,也没有正确使用HTTP协议 (这是REST API的关键特性)。实际上,属于此级别的API不会充分利用或利用HTTP协议的全部潜力。HTTP仅被视为传输层协议或仅仅是客户端和服务器之间的隧道机制。
第1级:基于资源的地址/ URI
- 这是REST API的起始级别。在这个层面上,概念的资源基础地址被 引入,它告诉你应该有个人的URI服务器上的每个资源(不像LEVEL 0,我们有一个单一的URI从客户端的每个传入的请求)。
- 这就像减少了从单个端点(处理所有操作的LEVEL 0端点)到多个基于资源的URI(如Divide and Conquer算法)的负担。
- 示例:创建发送到URI1的推文请求,删除推文请求转到URI2等。因此,无论我们是创建新推文,删除推文,还是更新推文,操作信息(创建,更新,删除推文)仍然是在请求正文中。在上面的twitter API中,我们可以将TWEET,COMMENT和FOLLOWER视为上述应用程序中的不同资源。
- 如果我们只是设计了基于资源的URI 而没有其他任何东西,那么我们处于成熟度模型的第1级。在这种情况下,HTTP仅用作客户端和服务器之间的隧道,我们没有利用HTTP作为应用程序层协议的潜力。
- 大多数REST初学者都是在这个LEVEL上设计REST API:
第2级:利用HTTP的潜力作为应用层协议
- 在此级别下开发的REST充分利用了HTTP作为应用程序层协议的全部潜力。
- 在此LEVEL开发的REST API使用标准HTTP方法/谓词和不同的HTTP状态代码对资源URI执行不同的操作。因此,请求机构将不再提供此级别的操作信息。因此,这个API比在LEVEL 0和LEVEL 1开发的API要成熟得多。
第3级:使用超媒体或HATEOAS
- 在第1级中, 引入了基于资源的URI概念,在第2节中,我们利用HTTP方法充分利用了HTTP协议。LEVEL 3使用Hypermedia (也称为HATEOAS -Hypermedia作为REST世界中的应用程序状态引擎),它驱动API客户端的交互。通常,API客户端不知道所有资源端点,并且REST不会处理API文档(它可以告诉API客户端有关所有端点的信息),这与我们拥有WSDL的SOAP不同,后者向API客户端提供有关服务的信息。
- 使用概念HATEOAS使不同的基于资源的端点知道API客户端,即发送一些超媒体作为端点响应的响应,其反过来充当应用程序状态的引擎,因此名称为HATEOAS。REST API中的HATEOAS概念使API自我记录,因此不需要API文档。
- 在这个LEVEL 3开发的API通常被认为是完全RESTful API,这是我们看到REST API的魅力所在。
HATEOAS:
超媒体作为应用程序状态引擎(HATEOAS)是REST应用程序体系结构的一个组件,它将其与其他网络应用程序体系结构区分开来。
使用HATEOAS,客户端与网络应用程序交互,其应用程序服务器通过超媒体动态提供信息。除了对超媒体的一般理解之外,REST客户端几乎不需要知道如何与应用程序或服务器交互。
相比之下,CORBA中的客户端和服务器通过文档或接口描述语言(IDL)共享的固定接口进行交互。
HATEOAS约束将客户端和服务器分离的方式使服务器功能能够独立发展。
示例:
REST客户端通过简单的固定URL进入REST应用程序。客户端可能采取的所有未来操作都在服务器返回的资源表示中发现。用于这些表示的媒体类型以及它们可能包含的链接关系是标准化的。客户端通过从表示中的链接中进行选择或通过以其媒体类型提供的其他方式操纵表示来转换应用程序状态。通过这种方式,RESTful交互由超媒体驱动,而不是带外信息。[1]
例如,[2]此GET请求获取帐户资源,以XML表示形式请求详细信息:
回应是:
回复包含以下可能的后续链接:进行存款,取款或转账,或关闭账户。
稍后检索帐户信息时,帐户会透支:
现在只有一个链接可用:存入更多钱。在当前状态下,其他链接不可用。因此,术语引擎应用状态。可能的操作因资源状态的不同而有所不同。
客户端不需要了解服务器提供的每种媒体类型和通信机制。通过服务器提供给客户端的“ 按需代码 ”,可以在运行时获取理解新媒体类型的能力。
参考:
https://en.wikipedia.org/wiki/HATEOAS
https://developers.redhat.com/blog/2017/09/13/know-how-restful-your-api-is-an-overview-of-the-richardson-maturity-model/
下一篇: 在YAML里,层级结构与数组间的差异详解
推荐阅读
-
Restful levels层级 和HATEOAS原则
-
RESTful levels & HATEOAS
-
纯干货分享 | 研发效能提升——敏捷需求篇-而敏捷需求是提升效能的方式中不可或缺的模块之一。 云智慧的敏捷教练——Iris Xu近期在公司做了一场分享,主题为「敏捷需求挖掘和组织方法,交付更高业务价值的产品」。Iris具有丰富的团队敏捷转型实施经验,完成了企业多个团队从传统模式到敏捷转型的落地和实施,积淀了很多的经验。 这次分享主要包含以下2个部分: 第一部分是用户影响地图 第二部分是事件驱动的业务分析Event driven business analysis(以下简称EDBA) 用户影响地图,是一种从业务目标到产品需求映射的需求挖掘和组织的方法。 在软件开发过程中可能会遇到一些问题,比如大家使用不同的业务语言、技术语言,造成角色间的沟通阻碍,还会导致一些问题,比如需求误解、需求传递错误等;这会直接导致产品的功能需求和要实现的业务目标不是映射关系。 但在交付期间,研发人员必须要将这些需求实现交付,他们实则并不清楚这些功能需求产生的原因是什么、要解决客户的哪些痛点。研发人员往往只是拿到了解决方案,需要把它实现,但没有和业务侧一起去思考解决方案是否正确,能否真正的帮助客户解决问题。而用户影响地图通常是能够连接业务目标和产品功能的一种手段。 我们在每次迭代里加入的假设,也就是功能需求。首先把它先实现,再逐步去验证我们每一个小目标是否已经实现,再看下一个目标要是什么。那影响地图就是在这个过程中帮我们不断地去梳理目标和功能之间的关系。 我们在软件开发中可能存在的一些问题 针对这些问题,我们如何避免?先简单介绍做敏捷转型的常规思路: 先做团队级的敏捷,首先把产品、开发、测试人员,还有一些更后端的人员比如交互运维的同学放在一起,组成一个特训团队做交付。这个团队要包含交付过程中所涉及的所有角色。 接着业务敏捷要打通整个业务环节和研发侧的一个交付。上图中可以看到在敏捷中需求是分层管理的,第一层是业务需求,在这个层级是以用户目标和业务目标作为输入进行规划,同时需要去考虑客户的诉求。业务人员通过获取到的业务需求,进一步的和团队一起将其分解为产品需求。所以业务需求其实是我们真正去发布和运营的单元,它可以被独立发布到我们的生产环境上。我们的产品需求其实就是产品的具体功能,它是我们集成和测试的对象,也就是我们最终去部署到系统上的一个基本单元。产品需求再到了我们的开发团队,映射到迭代计划会上要把它分解为相应的技术任务,包括我们平时所说的比如一些前端的开发、后端的开发、测试都是相应的技术任务。所以业务敏捷要达到的目标是需要去持续顺畅高质量的交付业务价值。 将这几个点串起来,形成金字塔结构。最上层我们会把业务目标放在整个金字塔的塔尖。这个业务目标是通过用户的目标以及北极星指标确立的。确认业务目标后再去梳理相应的业务流程,最后生产。另外产品需求包含了操作流程和业务规则,具需求交付时间、工程时间以及我们的一些质量标准的要求。 谈到用户影响的地图,在敏捷江湖上其实有一个传说,大家都有一个说法叫做敏捷需求的“任督二脉”。用户影响地图其实就是任脉,在黑客马拉松上用过的用户故事地图其实叫督脉。所以说用户影响地图是在用户故事地图之前,先帮我们去梳理出我们要做哪些东西。当我们真正识别出我们要实现的业务活动之后,用户故事地图才去梳理我们整个的业务工作流,以及每个工作流节点下所要包含的具体功能和用户故事。所以说用户影响地图需要解决的问题,我们包括以下这些: 首先是范围蔓延,我们在整张地图上,功能和对应的业务目标是要去有一个映射的。这就避免了一些在我们比如有很多干系人参与的会议上,那大家都有不同想法些立场,会提出很多需求(正确以及错误的需求)。这个时候我们会依据目标去看这些需求是否真的是会影响我们的目标。 这里提到的错误需求,比如是利益相关的人提出的、客户认为产品应该有的、某个产品经理需求分析师认为可以有的....但是这些功能在用户影响地图中匹配不到对应目标的话,就需要降低优先级或弃掉。另外,通常我们去制定解决方案的时候,会考虑较完美的实现,导致解决方案括很多的功能。这个时候关键目标至关重要,会帮助我们梳理筛选、确定优先级。 看一下用户影响到地图概貌 总共分为一个三层的结构: 第一层why,你的业务目标哪个是最重要的,为什么?涉及到的角色有哪些? 第二层how ,怎样产生影响?影响用户角色什么样的行为? (不需要去列出所有的影响,基于业务目标) 第三层what,最关键的是在梳理需求时不需一次把所有细节想全,这通常团队中经常遇到的问题。 我们用这个例子来看一下 这是一个客服中心的影响地图,业务目标是 3个月内不增加客服人数的前提下能支持1.5倍的用户数。此业务目标设定是符合 smart 原则的,specific非常的具体,miserable 是可以衡量的,action reoriented是面向活动的, real list 也是很实际的。 量化的目标会指引我们接下来的行动,梳理一个业务目标,尽量去量化,比如 :我们通过打造一条什么样的流水线,能够提高整个部署的效率,时间是原来的 1/2 。这样才是一个能量化的有意义的目标。 回到这幅图, how 层级识别出来的内容,客服角色:想要对它施加的影响,把客户引导到论坛上,帮助客户更容易的跟踪问题,更快速的去定位问题。初级用户:方论坛上找到问题。高级用户:在论坛上回答问题。通过我们这些用户角色,进行活动,完成在不增加客户客服人数的前提下支持更多的用户数量。 最后一个层级,才是我们日常接触比较多的真正的功能的特性和需求,比如引导到客户到论坛上,其实这个产品就需要有一个常见问题的论坛的链接。这个层次需要我们团队进一步地在交付,在每个迭代之前做进一步的梳理,细化成相应的用户故事。 这个是云智慧团队中,自己做的影响地图的范例,可以看下整个的层级结构。序号表示优先级。 那我们用户影响地图可以总结为: