API平台-如何创建自定义集合操作(GET)?
创始人
2024-09-08 00:30:40
0
  1. 首先,在您的实体资源(如User或Book)的路径下,使用Symfony框架的生成器创建自定义操作。

例如,在安装了API Platform的Symfony项目中,使用以下命令:

php bin/console make:operation User custom-action

这将创建一个名为customAction的类,该类继承自AbstractCollectionOperation。

  1. 接着在customAction类中,您可以实现自己的逻辑。以下是一个简单的示例,该示例从API Platform中获取所有用户数据,然后仅保留用户名和电子邮件地址信息来返回一个新的自定义集合操作。

use ApiPlatform\Core\Bridge\Doctrine\Orm\Paginator; use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface; use ApiPlatform\Core\Exception\RuntimeException; use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface; use ApiPlatform\Core\Util\RequestParser; use Doctrine\ORM\EntityManagerInterface; use Symfony\Component\HttpFoundation\Request;

final class CustomAction { private $entityManager; private $resourceMetadataFactory;

public function __construct(EntityManagerInterface $entityManager, ResourceMetadataFactoryInterface $resourceMetadataFactory)
{
    $this->entityManager = $entityManager;
    $this->resourceMetadataFactory = $resourceMetadataFactory;
}

public function __invoke(Request $request, QueryNameGeneratorInterface $queryNameGenerator): iterable
{
    $resourceClass = $request->attributes->get('resource_class');
    $collectionOperationName = $request->attributes->get('collection_operation_name');

    $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
    $collectionOperations = $resourceMetadata->getCollectionOperations();

    if (!array_key_exists($collectionOperationName, $collectionOperations)) {
        throw new RuntimeException(sprintf('Operation "%s" not found for resource "%s".', $collectionOperationName, $resourceClass));
    }

    $em = $this->entityManager;
    $qb = $em->createQueryBuilder()
        ->select('u.username', 'u.email')
        ->from('App\Entity\User', 'u');

    $result = new Paginator($qb->getQuery());
    $result->setItemCountPerPage($request->query->getInt(RequestParser::PAGE_SIZE, 30));

    return $result;
}

}

  1. 确认您已添加到集合操作的配置和路由。

您需要将此自定义的操作配置添加到实体的yaml文件(如:src/Resources/config/api_platform/User.yaml),然后在路由中定义它。

例如,在User.yaml文件中添加以下内容:

collection_operations: custom_action: method:

相关内容

热门资讯

2026外挂!雀友会广东潮汕麻... 2026外挂!雀友会广东潮汕麻将辅助软件,芒果辅助器(好像是有挂)1、用户打开应用后不用登录就可以直...
2026外挂!哈糖大菠萝辅助,... 2026外挂!哈糖大菠萝辅助,奇迹手游辅助脚本平台免费(一直真的有挂)1、奇迹手游辅助脚本平台免费脚...
2026外挂!辅助定制交易平台... 2026外挂!辅助定制交易平台,情怀破解(本来有挂)1、起透看视 辅助定制交易平台辅助软件价格2、随...
2026外挂!九酷众游软件,5... 2026外挂!九酷众游软件,510k中至余干辅助(原来真的是有挂)1、玩家可以在510k中至余干辅助...
2026外挂!极速官方游戏暗堡... 2026外挂!极速官方游戏暗堡辅助器,楚天游辅助(其实存在有挂)1、上手简单,内置详细流程视频教学,...
2026外挂!免费游戏辅助软件... 2026外挂!免费游戏辅助软件,如何设置钱塘十三水辅助器(切实是真的有挂)1、2026外挂!免费游戏...
2026外挂!雀姬辅助脚本,微... 2026外挂!雀姬辅助脚本,微乐游戏辅助脚本安装(切实有挂)2026外挂!雀姬辅助脚本,微乐游戏辅助...
2026外挂!飞驰娱乐软件科技... 2026外挂!飞驰娱乐软件科技,科乐填大坑辅助器(切实真的有挂)1、科乐填大坑辅助器免费辅助多个强度...
2026外挂!皮皮胡子辅助,天... 2026外挂!皮皮胡子辅助,天天贵阳破解版(原来是真的有挂)天天贵阳破解版是不是有人用挂微扑克wpk...
2026外挂!科技实测欢乐辅助... 2026外挂!科技实测欢乐辅助,丽水都莱辅助软件(都是是有挂)小薇(辅助器软件下载)致您一封信;亲爱...