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:

相关内容

热门资讯

热点推荐(轰趴大菠萝)外挂透明... 热点推荐(轰趴大菠萝)外挂透明挂辅助神器(智能ai代打)原来真的有挂(2020已更新)(微博热搜)1...
玩家必看秘籍(wepower)... 玩家必看秘籍(wepower)外挂透明挂辅助脚本(智能ai代打)其实真的有挂(2020已更新)(哔哩...
教程攻略(fishpoker)... 教程攻略(fishpoker)外挂透明挂辅助安装(透视)总是真的有挂(2020已更新)(哔哩哔哩)1...
总算了解(wepower德州)... 总算了解(wepower德州)外挂透明挂辅助工具(智能ai代打)果真真的有挂(2022已更新)(百度...
推荐十款(wpK)外挂透明挂辅... 推荐十款(wpK)外挂透明挂辅助工具(辅助挂)的确是有挂的(2023已更新)(头条)辅助器中分为三种...
一分钟了解(pokerx)外挂... 一分钟了解(pokerx)外挂透明挂辅助黑科技(软件透明挂)的确是有挂的(2021已更新)(抖音)1...
重大消息(德州nzt)外挂透明... 重大消息(德州nzt)外挂透明挂辅助插件(软件透明挂)一般真的有挂(2025已更新)(百度)1、任何...
分享认知(拱趴大菠萝)外挂透明... 分享认知(拱趴大菠萝)外挂透明挂辅助app(智能ai代打)都是真的有挂(2022已更新)(哔哩哔哩)...
教程攻略(Aapoker)外挂... 教程攻略(Aapoker)外挂透明挂辅助软件(软件透明挂)果然真的有挂(2021已更新)(百度)1、...
玩家亲测(红龙软件德州扑克)外... 玩家亲测(红龙软件德州扑克)外挂透明挂辅助挂(智能ai代打)就是真的有挂(2020已更新)(头条)1...