如何使用与任何特定实体无关的参数编写自定义endpoint

Question

我正在尝试编写自定义 GET endpoint，这些endpoint必须具有一个或多个自定义参数，但不构建在特定实体之上。

类似于:/assets/{ device _ id }/{ scene _ id }/{ maybe _ other _ param }

我想象它只是自己的控制器类，我在其中做一些事情，从输入中计算值，手动读取一些数据并返回实体数组。我只得到一个资产实体，但它需要{设备}和{场景}是这个实体的属性…

我不希望这是一个暴露的实体，通过它的属性过滤，我只需要在API中看到简单的endpoint，作为普通的自定义控制器，带一些参数，做一些事情，并返回json。

这听起来很简单，但我阅读了大量的文档和示例，仍然没有找到任何东西。这在API平台中是可能的吗？

Answer 1

如果您希望将路径中的参数直接传递到控制器，则需要使用 “read”=false 配置操作。以下是我可以使用此类收集操作的最简单的资产资源：

namespace App\Entity;

use ApiPlatform\Core\Annotation\ApiResource;
use ApiPlatform\Core\Annotation\ApiProperty;
use App\Controller\GetAssetCollectionByPathParams;

/**
 * @ApiResource(
 *     collectionOperations={
 *         "get",
 *         "get_by_path_params"={
 *             "method"="GET",
 *             "controller"=GetAssetCollectionByPathParams::class,
 *             "path"="/assets/{device_id}/{scene_id}/{maybe_other_param?}",
 *             "read"=false,
 *             "pagination_enabled"=false,
 *             "openapi_context"={
 *                 "summary"="Get by path parameters",
 *                 "parameters"={
 *                     {
 *                         "name" = "device_id",
 *                         "in" = "path",
 *                         "required" = true,
 *                         "type" = "integer"
 *                     },
 *                     {
 *                         "name" = "scene_id",
 *                         "in" = "path",
 *                         "required" = true,
 *                         "type" = "string"
 *                     },
 *                     {
 *                         "name" = "maybe_other_param",
 *                         "in" = "path",
 *                         "required" = false,
 *                         "type" = "string"
 *                     }
 *                 }
 *             }
 *         }
 *     },
 *     itemOperations={
 *         "get"
 *     }
 * )
 */
class Asset
{

    /** @var string */
    public $description;

    /**
     * @return int
     * @ApiProperty(identifier=true)
     */
    public function getId()
    {
        return time();
    }
}

我用以下Controller类测试了它：

namespace App\Controller;

use App\Entity\Asset;

class GetAssetCollectionByPathParams
{
    /**
     * @return Asset[]
     */
    public function __invoke($device_id, $scene_id, $maybe_other_param=null) :array
    {
        $result = new Asset();
        $result->description = "GetAssetCollectionByPathParams result for device_id: $device_id, scene_id: $scene_id, maybe_other_param: $maybe_other_param";
        return [$result];
    }
}

也适用于GET项目操作。对于输出为资源的集合操作，不要删除任何默认的“get”操作，否则IriConverter无法生成必要的iri。如果你不想这样做，你必须输出一个不是资源的DTO或其他，并将输出=配置为输出的类。然后你也需要纠正招摇文档，有关集合操作的示例，请参阅我教程的chapter9-api分支。有关POST操作，请参阅我对此问题的回答。