API平台-我应该使用哪种方法创建没有实体的自定义操作

Question

我是API平台的新手。我认为这很好，但我找不到任何示例来创建不基于任何实体的自定义endpoint。有很多基于实体的示例，通常都是关于CRUD的。但是定制操作呢？

我需要使用一些与任何实体无关的自定义参数通过数据库创建自定义搜索。例如，我想收到这样的 POST 请求：

{
   "from": "Paris",
   "to": "Berlin"
}

这些数据没有保存到db，我也没有实体。在我收到这些数据后，应该有很多业务逻辑，包括通过许多db表进行db查询，以及从外部来源获取数据。然后，在业务逻辑完成后，我想返回也是自定义的并且与任何实体无关的结果。例如。

{
    "flights": [/* a lot of json data*/],
    "airports": [/* a lot of json data*/],
    "cities": [/* a lot of json data*/],
    .......
}

所以，我想我不是唯一一个做类似事情的人。但是我真的找不到解决方案或最佳实践来做到这一点。在文档中，我发现至少有三种方法，但我一种都不能实现。最好的一个，我想最适合我的是使用自定义操作和控制器。但是文档上说不推荐这个。此外，我认为我应该使用dto进行请求和响应，但是对于这种方法，我不确定我能不能使用它们。

我发现第二种方法是使用数据传输对象，但这种方法需要一个实体。根据文档，我应该使用DTO和DataTransformers将DTO转换为实体。但我不需要实体，我不需要将其保存到数据库。我只想自己处理收到的DTO。

第三个我猜是使用数据提供者，但我不确定它是否适合我的要求。

所以，主要问题是我应该使用哪种方法或最佳实践来实现与任何实体无关的自定义操作。使用DTO进行请求和响应将是很棒的。

Answer 1

你没有被强迫使用实体。用< code>@ApiResource批注标记的类可能不是实体。实际上，如果你的应用比基本的CRUD聪明，你应该避免将实体标记为ApiResource。

因为您想使用POST HTTP方法（用于创建资源项），所以可以这样做。

1)定义描述搜索字段的类，它将是您的< code>@ApiResource

<?php
// src/ApiResource/Search.php 

namespace App\ApiResource;

use ApiPlatform\Core\Annotation\ApiResource;
use ApiPlatform\Core\Action\NotFoundAction;
use ApiPlatform\Core\Annotation\ApiProperty;
use App\Dto\SearchResult;

/**
 * @ApiResource(
 *     itemOperations={
 *         "get"={
 *             "controller"=NotFoundAction::class,
 *             "read"=true,
 *             "output"=false,
 *         },
 *     },
 *     output=SearchResult::class
 * )
 */
class Search
{
    /**
     * @var string
     * @ApiProperty(identifier=true)
     */
    public $from;

    /** @var string */
    public $to;
}

2）定义表示输出的DTO

<?php
// src/Dto/SearchResult.php

namespace App\Dto;

class SearchResult
{
    public $flights;
    public $airports;
    public $cities;
}

3）创建将填充DataPersister接口以处理业务逻辑的类。它将被框架调用，因为你发出 POST 请求。

<?php
// src/DataPersister/SearchService.php

declare(strict_types=1);

namespace App\DataPersister;

use ApiPlatform\Core\DataPersister\DataPersisterInterface;
use App\Dto\SearchResult;
use App\ApiResource\Search;

final class SearchService implements DataPersisterInterface
{
    public function supports($data): bool
    {
        return $data instanceof Search;
    }

    public function persist($data)
    {
        // here you have access to your request via $data
        $output = new SearchResult();
        $output->flights = ['a lot of json data'];
        $output->airports = ['a lot of json data'];
        $output->cities = ['inputData' => $data];
        return $output;
    }

    public function remove($data)
    {
        // this method just need to be presented
    }
}

这样，您将根据请求收到结果。