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:

相关内容

热门资讯

今日头条!微信老友广东辅助器,... 今日头条!微信老友广东辅助器,微乐福建辅助器,安装教程(原来有开挂辅助器)是一款可以让一直输的玩家,...
每日必看推荐!微信小程序家乡大... 每日必看推荐!微信小程序家乡大二辅助工具,新西游辅助器,透视教程(原来有开挂辅助安装);1、选手技艺...
玩家亲测!广东插件智能插件安装... 玩家亲测!广东插件智能插件安装包免费,wepoker轻量版有透视吗,详细教程(原来有开挂辅助挂);广...
重大通报!哈糖大菠萝开挂,we... 重大通报!哈糖大菠萝开挂,we-poker是什么软件,解密教程(原来有开挂辅助助手);1.哈糖大菠萝...
解密关于!鱼乐达人辅助修改器,... 解密关于!鱼乐达人辅助修改器,下载微乐小程序自建房透视,介绍教程(原来有开挂辅助软件);解密关于!鱼...
重大发现!四川家园游戏辅助,微... 重大发现!四川家园游戏辅助,微乐自建房辅助多少钱一个月,AI教程(原来有开挂辅助器);微乐自建房辅助...
玩家必用!玉海楼茶苑怎么开挂,... 玩家必用!玉海楼茶苑怎么开挂,天酷互娱有辅助工具嘛,黑科技教程(原来有开挂辅助插件);天酷互娱有辅助...
一分钟教你!椰岛常胜游戏破解,... 一分钟教你!椰岛常胜游戏破解,广东雀神透视,解密教程(原来有开挂辅助下载);椰岛常胜游戏破解软件透明...
实测发现!三江互娱辅助,wpk... 实测发现!三江互娱辅助,wpk显示有透视挂,详细教程(原来有开挂辅助助手),三江互娱辅助是用手机号来...
程序员教你!长春科乐第三方辅助... 程序员教你!长春科乐第三方辅助工具,wepoker代打辅助机器人,曝光教程(原来有开挂辅助黑科技);...