使用 REST 进行通用过滤/排序的最佳方法

Question

我们正在构建一个基于 .NET 的 REST API，我们的单页 JavaScript 应用程序以及未来可能的其他消费者将使用该 API。该应用程序将有许多显示数据的网格，并允许用户应用自定义过滤器和排序。诸如等于、包含、大于、小于、开头等。

是否有一种公认的方法可以在 URL 方案中实现这一点？尤其是不同的运营商。我不认为我将过滤器视为一流的资源，我可能希望使用查询参数来表达过滤/排序。

看起来 OData 为此类问题提供了解决方案，但总体而言，它似乎是一种重量级的方法，我担心它的接受度。有更轻、更受欢迎的替代品吗？

Answer 1

因为您正在考虑对数据进行多项操作：过滤、排序等，我会说在您的端点上公开 IQueryable 并使用 OData。

我会开始here。

请注意，在您的 API 上启用 OData 并不意味着您正在完全打开您的数据，您可以始终仅启用某些操作，等等。

查看here 以更好地了解如何保护暴露 OData 的 API。

我还没有尝试过任何其他替代方案，但我想你总是可以结合你的路线和动作来获得你需要的功能：顶部、过滤器、排序等。