Swagger和HATEOAS之间的区别

时间:2019-02-23 08:28:46

标签: rest spring-mvc swagger spring-hateoas

谁能解释Swagger和HATEOAS之间的区别。我可以搜索很多次,但是没有朋友可以解释这两个方面的正确详细答案。

2 个答案:

答案 0 :(得分:3)

Swagger和HATEOAS IMO之间的主要区别(未包含在接受的答案中)是Swagger仅用于RPC'esque API。但是,此类API实际上与REST无关。

还有一个更广泛的误解,即通过HTTP交换的任何东西都是自动RESTful的(〜符合REST建筑风格),事实并非如此。 REST只是定义了一组约束,这些约束不是选择或选项,而是强制性的。从开始到结束。没有RESTful并没有什么错,但是称这样的架构REST是错误的。

Swagger描述可以在端点上执行的操作以及需要发送到服务的有效负载(包括标头和期望的表示格式),还描述客户端可能期望作为响应。这使得Swagger既可以用作API的文档,也可以用作测试框架。由于Swagger与API紧密耦合,因此其行为非常类似于典型的RPC服务描述,即类似于SOAP中的WSDL文件,RMI或CORBA中的存根或骨架类。如果端点发生更改或有效负载中的某些内容发生更改,则针对Swagger文档实施的客户端可能会随着时间的推移而中断,只是重新引入了典型RPC实现所遇到的相同问题。

另一方面,REST和HATEOAS旨在用于贫困和进一步发展。 REST不是协议,而是一种架构风格,它描述了分布式系统中客户端和服务器之间的交互流。它基本上采用了使Web如此成功的概念并将其转换到应用程序层。因此,适用于可浏览Web的相同概念也适用于REST。因此,HATEOAS(对链接,链接关系和链接名称的使用和支持)的行为类似于网络,这并非奇迹。

在设计REST体系结构时,考虑一种状态机是有益的,服务器在该状态机中提供了客户端需要采取进一步行动的所有信息。 AsbjørnUlsberg在2016年进行了一次精彩的演讲,explains affordances and how a state machine might be implemented through HATEOAS。除了常见或标准化的媒体类型和关系名称外,无需带外知识即可与服务进一步交互。以Asbjørn在演讲中举的烤面包机为例,烤面包机可能具有状态offonheatingidle,在这些状态下打开烤面包机会导致从offon的状态过渡,然后过渡到heating直到达到一定温度,在该温度下状态过渡到idle并在idle之间切换和heating,直到烤面包机关闭。

HATOAS将向客户提供有关当前状态的信息,并包括客户可以调用以链接到下一个状态的链接,即再次关闭烤面包机。在这里需要强调的是,服务器为客户端提供了客户端可能执行的每个操作。客户端实现者无需查阅任何专有的API文档即可使客户端能够与REST服务进行交互。此外,由于客户端将通过链接关系名称确定调用该URI是否有意义,因此URI不必具有有意义的含义或设计为传达语义表达结构。此类关系名称由IANA,通过常见的方法(例如Dublin Coreschema.org)或由充当extension attributes的绝对URI(可能指向人类可读的描述)指定,还可以通过鼠标悬停工具提示等将其传播给用户。

我希望您能自己看到Swagger仅用于描述RPC Web-API,而无需遵循REST体系结构设计的应用程序。通过REST API交换的消息应包括客户端在下一次状态转换时做出明智选择所需的所有信息。因此,将这样的消息流和交互设计为状态机是有益的。

答案 1 :(得分:0)

Swagger:Swagger在整个API生命周期(从设计和文档到测试和部署)的整个开发过程中提供帮助。 [请参阅swagger.io]

HATEOAS:超媒体作为应用程序状态的引擎

离子表格是一个集合对象,其中值成员数组包含表格字段。离子表格可确保自动发现支持数据提交的资源转换(链接)(俗称HATEOAS)。 [请参阅https://ionspec.org/]

一个是支持API设计和测试的框架,另一个是API设计架构。