用HAL呈现分页资源的正确方法是什么？

Question

这听起来像是一个菜鸟问题，但我想知道以HAL格式显示分页资源的最佳方法是什么？ 现在，我正在使用Spring HATEOAS API将Page对象转换为资源PagedResourcesAssembler#toResource(Page<T>, ResourceAssembler<T,R>) 。 结果为以下输出：

{
"_links": {
    "self": {
        "href": "http://example.org/api/user?page=3"
    },
    …
}
"count": 3,
"total": 498,
"_embedded": {
    "users": [
        {
            "_links": {
                "self": {
                    "href": "http://example.org/api/user/mwop"
                }
            },
            "id": "mwop",
            "name": "Matthew Weier O'Phinney"
        }
    ]
}

}

一切正常，但是唯一的问题是要返回的集合在_embedded字段下并且具有类名，因此客户端也必须知道该类名，对吗？ 仅以非HAL格式的content返回集合会更好吗？ 如果是，我应该如何使用Spring HATEOAS实现它？

Answer 1

没问题，这就是HAL规范中定义_embedded的方式。

users不是一个类，它是一个链接关系，它使客户端可以首先真正找到它所要的集合（例如，使用JSONPath表达式）。 这根本不是什么让人吃惊的事情，但通常是相同的链接关系，客户端首先是用来查找该资源的。

假设有一个API根目录公开了此文档：

{
  "_links": {
    "users": {
      "href": "…"
    },
    …
  }
}

看到这一点，客户端将必须了解users的语义才能找到它想要遵循的链接。 在您的情况下， users基本上是指向支持分页的集合资源。

因此，如果客户端遵循名为users的链接，则可以通过结合有关媒体类型（HAL， _embedded ）和服务的应用程序级语义（ users ）的知识，在HAL响应中的_embedded.users下查找正在寻找的实际内容。 。