url - 用于资源收集的 REST url，它按不等于给定值的属性过滤资源

Question

如何为资源收集设计 REST url，它按不等于给定值的属性过滤资源？

例如，要获取 8 年级的学生，我们使用

GET /students?grade=8

如何做同样的事情，如果我们需要得到学生 不是 八年级？以及如何设计小于( <)，大于( >)等？

Answer 1

一种选择是添加一个额外的查询参数，例如 gradeOperator您可以在其中传递将值与 grade 进行比较时要使用的运算符。范围。例如。，

GET /students?grade=8&gradeOperator=!%3D

!%3D是 URL-encoded !=的表格，因此您的 REST API 将对运算符进行解码并将其解释为 grade != 8 .

另一种方法是在 HTTP 请求正文中传递值和运算符。像这样的事情可能会起作用(以 JSON 中提供的正文为例):

GET /students
Content-Type: application/json

{ "grade": {"value": 8, "operator": "!=" } }

这可能很好，因为您不必在 gradeOperator 中重复“等级”这个词，该运算符只是作为 grade 的值嵌套在 JSON 对象中。 .

在任一解决方案中，您都可以定义任意数量的运算符，包括 < , > , >= , <=等。请确保正确清理您的 API 接收的任何输入运算符，尤其是在数据库查询中使用时，以避免诸如 SQL injection 之类的事情。攻击。