获取rest服务的对象传递列表

Question

我想把一个对象列表传递给一个Java rest服务。例如，循环列表。

class Cycle {
    private String id;
    private LocalDate date;   
}

@GetMapping("results")
public Result results(List<Cycle> cycles)

或者有一个包含列表的CyclesWrapper类。而不是传递列表cycleDates和列表CycleIds。

如何使用例如邮递员或curl将参数传递给rest服务？

因此，为了传入列表 says cycleIds，请求将是:http://localhost:8080/application/results？cycleIds=xx，yy

谢谢

Answer 1

按照当前的情况，您的端点将把cycles解释为查询参数，这意味着它将期望以下类型的请求:

GET /results?cycles=...

对于复杂对象列表，这不是标准方法。您可以将对象作为/results？cycle1id=abc&cycle1date=22-10&cycle2id=def&cycle2date=10-10&...传递，但这会非常麻烦，容易出错，并且需要在您的端进行自定义映射才能使其工作。此外，据我所知，没有发送查询数组参数的标准。

相反，你可以做的是:

1. 将端点更改为POST端点，将循环（即过滤器）列表作为标准@requestbodyJSON传递。这将如下所示:

@PostMapping("results")
public Result results(@RequestBody List<Cycle> cycles)

现在您的请求应该是:

POST /results
{
    [
        {"abc", "22-10"},
        {"def", "10-10"}
    ]
}

由于post几乎可以做任何事情，因此它也可以在这个端点上返回一个过滤的响应。然而，这并不是一个很好的休息。

@GetMapping("results")
public Result results(@RequestParam List<String> ids, @RequestParam List<LocalDate> dates)

然后它将期望收到如下请求:

GET /results?ids=abc,def&dates=22-10,10-10

作为逗号分隔的列表。这更符合RESTful端点，尽管它也有点麻烦。

最后，似乎您的端点试图同时做两件事:在id和date上筛选。由于我不确定什么类型的逻辑工作代表一个循环，也许这些应该被拆分成两个不同的端点，例如:

GET /results/abc?dateFrom=22-10&dateUntil=23-10

其中/abc表示单数对象。在您的特定情况下，这表示的是结果还是循环，我不能说。你得自己评估一下。