rest - 使用 REST 和 HATEOAS 的非上下文操作

Question

我正在尝试为酒店预订实现基于 HATEOS 的 REST 服务，但有这样的困惑:

1) 除了 WADL 之外，客户端如何了解可能的操作及其对应的 URI。当客户端访问 REST 服务的根时，我是否应该将所有可能的操作和 URI 作为响应？

2) 当客户获得一个地区所有住宿选择的列表时，我将返回他询问的该地区所有酒店的列表。响应包含:

<accommodation>
  <hotel info="http://welco.me/hotel/xxxxxx" price="5000"/>
  <hotel info="http://welco.me/hotel/yyyyyyy" price="3000"/>
</accommodation>

但我这里的问题是客户如何知道其他相关的可能操作，例如按价格排序获取列表？

Answer 1

1. 在回答您的第一个问题时，有一些文档规范允许客户发现 RESTful API。

• Swagger
• JSON Home
• Google 使用自己的 Discovery Service ，但与 Swagger 和 JSON Home 不同，不幸的是，我认为没有开源库可以帮助您将其用于自己的 API。

1. 对于您的第二个问题，我倾向于让客户/开发人员发现参数，例如从 Swagger/JSON Home 文档中进行排序。但是，如果它是一个 super 强大/重要的关系，您也可以在响应中将其作为链接数据返回:

• 在HAL您可以提供一个包含指向相关资源的链接的 links 对象。
• 在JSON-LD您可以添加一个具有相关 API url 值的字段。然后，您可以添加一个 @content 来添加描述该关系含义的信息。