具有自定义请求正文的 API 平台自定义资源

Question

我对Symfony和API平台很陌生。我正在尝试创建一个自定义资源/操作，该资源/操作接收请求的正文，根据值从数据库中获取数据，然后将实体集合返回给客户端。

示例：具有以下正文的 GET 请求：

{
   "trackName": "example"
   "anotherKey": "anotherValue"
}

根据这些属性，我想查询数据，进行计算，然后返回数据。

我试图弄清楚如何使这个API平台的方式。我已经在谷歌上搜索并在留档中寻找了几个小时，但我找不到实现这一目标的方法。

我尝试使用CollectionDataProvider和如下所示的控制器查询数据：

/**
 * @ApiResource(
 *     itemOperations={
 *          "tracks_custom_endpoint"={
 *              "method"="GET",
 *              "path"="/tracks/custom_endpoint",
 *              "controller"=MyController::class,
 *              "read"=false
 *          }
 *     }
 * )
 * @ORM\Entity(repositoryClass=SpotifyTrackRepository::class)
 */
class Track
{
   // Attributes, setters and getters
}

但是，无论哪种方式，我都无法访问请求的正文以及随之发送的 JSON 数据。有没有办法以某种方式访问这些数据，然后处理它。

Answer 1

首先，考虑item的操作指定与单个资源交互的endpoint。而收集操作指定与整个资源集合交互的endpoint。听起来您的endpoint应该在收集操作下配置，因为您正在寻求返回过滤的资源集合，而不是单个资源。

其次，集合< code>GET操作期望请求体有效负载以提供集合过滤器是不常见的。这些通常使用查询参数来提供。API平台附带了许多现成的查询参数过滤器，涵盖了大多数用例(包括您的用例)。否则，使用扩展来进行更加定制和复杂的集合过滤。

最后，数据转换器允许您控制如何将输入(请求负载)转换为资源，或者如何将资源转换为输出(响应负载)。这似乎是你正在寻找的。然而，我建议在走这条路之前考虑一下我前面的观点。