使用HAL显示分页资源的正确方法是什么？

Question

这听起来像是一个新手问题，但我想知道用HAL格式呈现分页资源的最佳方式是什么？现在我正在使用Spring HATEOAS API将Page对象转换为资源PagedResourcesAssembler#toResource（页面

{
"_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"
        }
    ]
}

}

一切正常，但唯一的问题是返回的集合位于嵌入的字段下，并且有类名，所以客户端也必须知道这个类名，对吗？只需像非HAL格式一样在内容下返回集合是否更好？如果是，我应该如何使用Spring HATEOAS实现它？




Answer 1

这不是问题，这是HAL规范中定义嵌入式的方式。

user不是一个类，它是一个链接关系，它允许客户端实际找到它首先要求的集合（例如使用JSONPath表达式）。这根本不是突然出现的事情，但通常是相同的链接关系，客户端首先用于查找该资源。

假设API根公开此文档：

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

看到这一点，客户端必须知道user的语义学才能找到它想要遵循的链接。在您的案例中，user基本上指向支持分页的集合资源。

因此，如果客户端遵循名为“用户”的链接，则可以在“嵌入”下找到它要查找的实际内容。用户通过结合有关媒体类型（HAL，嵌入式）和服务的应用程序级语义（用户）的知识，在HAL响应中选择用户。