API平台-如何创建自定义集合操作(GET)?
创始人
2024-09-08 00:31:50
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:

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...