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:

相关内容

热门资讯

记者揭秘!智星菠萝辅助(透视辅... 记者揭秘!智星菠萝辅助(透视辅助)拱趴大菠萝辅助神器,扑克教程(有挂细节);模式供您选择,了解更新找...
一分钟揭秘!约局吧能能开挂(透... 一分钟揭秘!约局吧能能开挂(透视辅助)hhpoker辅助靠谱,2024新版教程(有挂教学);约局吧能...
透视辅助!wepoker模拟器... 透视辅助!wepoker模拟器哪个好用(脚本)hhpoker辅助挂是真的,科技教程(有挂技巧);囊括...
透视代打!hhpkoer辅助器... 透视代打!hhpkoer辅助器视频(辅助挂)pokemmo脚本辅助,2024新版教程(有挂教程);风...
透视了解!约局吧德州真的有透视... 透视了解!约局吧德州真的有透视挂(透视脚本)德州局HHpoker透视脚本,必胜教程(有挂分析);亲,...
六分钟了解!wepoker挂底... 六分钟了解!wepoker挂底牌(透视)德普之星开辅助,详细教程(有挂解密);德普之星开辅助是一种具...
9分钟了解!wpk私人辅助(透... 9分钟了解!wpk私人辅助(透视)hhpoker德州透视,插件教程(有挂教学);风靡全球的特色经典游...
推荐一款!wepoker究竟有... 推荐一款!wepoker究竟有透视(脚本)哈糖大菠萝开挂,介绍教程(有挂技术);囊括全国各种wepo...
每日必备!wepoker有人用... 每日必备!wepoker有人用过(脚本)wpk有那种辅助,线上教程(有挂规律);wepoker有人用...
玩家必备教程!wejoker私... 玩家必备教程!wejoker私人辅助软件(脚本)哈糖大菠萝可以开挂,可靠技巧(有挂神器)申哈糖大菠萝...