使用过滤器进行查询的RESTful方法是什么? [英] What's a RESTful way to query with filters?

问题描述

说我的应用程序正在管理带有以下字段的称为工作负载的对象.我想为用户提供一个REST接口，以便用户通过标签查询工作负载.

Say my application is managing objects called workload, with the following fields. I want to expose a REST interface for user to query workloads by labels.

"Workload": {"id":"test1", "labels":["A", "B", "C"]}
"Workload": {"id":"test2", "labels":["A", "C", "D"]}
"Workload": {"id":"test3", "labels":["A", "B", "D"]}

问题:如何设计REST终结点，以便通过多个标签作为过滤器来支持查询工作负载?

Question: How do I design the REST endpoint so that it would supports query workload by multiple labels as filter?

样本查询1 :我要GET同时包含"A"和"B"的所有工作负载.

Sample Query 1: I want to GET all the workloads with both "A" and "B".

我正在考虑将GET用作动词，将workloads用作端点，然后将{"labels": ["A", "B"]}用作请求正文.但这似乎不是一种RESTful的做事方式

I'm thinking something like GET as verb, workloads as endpoint, then use a {"labels": ["A", "B"]} as request body. But this does not seem like a RESTful way to do things

或者，我可以执行GET /labels/{label-id}/workloads，但是每次只能使用一个标签.

Alternatively, I can do GET /labels/{label-id}/workloads but this would only work with one label per time.

示例查询2 :我要GET所有带有标签"A"或"B"但没有"C"的工作负载

Sample Query 2: I want to GET all the workloads with label "A" or "B" but no "C"

除了要求用户分别通过A，B，C进行查询然后自己进行适当的设置操作外，根本不知道如何执行这种Rest API?

No clue how to do this sort of rest api at all, other than ask user to query by A, B, C separately then do proper set operations themselves?

第二个查询是被跟踪为另一个问题

推荐答案

使用查询参数，很好到重复它们.

GET /workloads?label=A&label=B&label=C

在简单的情况下，您也可以or和not这样的术语.

For simple cases you could alsoor and not the terms like this.

GET /workloads?or_label=A&or_label=B&label_not=C

这篇关于使用过滤器进行查询的RESTful方法是什么?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！