响应Rest页面请求的正确方法

Question

我想在Spring中创建一个符合REST的endpoint。endpoint应该允许分页。

请求非常简单，是否访问url/资源？页码=1

我发现了两种返回数据的大方法：

1. 返回包含以下内容的自定义对象：

{
    "page": 1,
    "pageSize": 20,
    "content": [
         {...},
         {...}
         ...
    ]
}

此方法的问题是它不再返回资源，而是返回资源的包装器。

[
   {...},
   {...}
   ...
]

这解决了资源问题，但它使endpoint更难使用，这是违反直觉的，因为它也需要额外的工作来实现。

我想知道，什么标准被更广泛地使用，为什么？对此的“新”方法是什么？我应该远离什么？有没有一种方法可以满足这两种需求？

提前感谢！

Answer 1

我在我使用的API中看到的最常见的做法是您使用对象包装器的第一个示例：

{
    "page": 1,
    "pageSize": 20,
    "content": [
         {...},
         {...}
         ...
    ]
}

通常，此对象包装器通过对endpoint的任何调用来实现。另一方面，当用户调用一个GET-resource/{resourceId}endpoint时，没有对象包装器。

这只是我对其他API使用情况的看法，但我已经编写了近100种不同的API集成，因此我看到了相当多的API集成。