例如,在安装了API Platform的Symfony项目中,使用以下命令:
php bin/console make:operation User custom-action
这将创建一个名为customAction的类,该类继承自AbstractCollectionOperation。
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;
}
}
您需要将此自定义的操作配置添加到实体的yaml文件(如:src/Resources/config/api_platform/User.yaml),然后在路由中定义它。
例如,在User.yaml文件中添加以下内容:
collection_operations: custom_action: method:
上一篇:API平台-获取作者为用户的集合
下一篇:API平台-添加新实体与子资源