Error handling 如果实体已存在,则返回实体-API平台
我有实体Error handling 如果实体已存在,则返回实体-API平台,error-handling,api-platform.com,Error Handling,Api Platform.com,我有实体标记,它具有唯一的属性标记值。当我对已经存在的tagValue进行POST时,我希望得到它的响应 config/validator/tag.yaml: App\Entity\Tag: constraints: - Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity: tagValue properties: tagValue: - NotBlank: ~ src/Entity/Tag
标记
,它具有唯一的属性标记值
。当我对已经存在的tagValue
进行POST
时,我希望得到它的响应
config/validator/tag.yaml
:
App\Entity\Tag:
constraints:
- Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity: tagValue
properties:
tagValue:
- NotBlank: ~
src/Entity/Tag.php
:
最后,我从GitHub上得到了一个答案(我真的很感谢他这么做),如果有人在同一个问题上卡住了,下面是:
你真幸运,我们刚刚在应用程序中实现了它。API平台中没有针对此功能的内置功能,我们必须重写某些类才能添加它
首先,这是当唯一约束有效时我们现在的反应:
{
"type": "https://tools.ietf.org/html/rfc2616#section-10",
"title": "An error occurred",
"detail": "number: This Usage Reference already exists with the same number and channel.",
"violations": [
{
"propertyPath": "number",
"message": "This Usage Reference already exists with the same number and channel."
}
],
"existingUniqueEntities": [
{
"uniquePropertyPaths": [
"number",
"channel"
],
"entity": {
"id": 1101,
"number": "23423423435",
"channel": "/api/channels/1",
"createdAt": "2019-07-17T07:25:50.721Z"
}
}
]
}
请注意,您可能有许多独特的违规行为,这样的模式可以返回许多已经存在且与提供的请求冲突的实体(例如,实体可以有两对独特的密钥,一对通过电子邮件,另一对通过引用)
此外,我们的实现使用的序列化组正是执行GET/resource所使用的序列化组,其中resource是您试图创建的资源。我们从api平台元数据中获取这些序列化组
下面是代码:
<?php
declare(strict_types=1);
namespace App\Serializer;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Serializer\AbstractConstraintViolationListNormalizer;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\SerializerInterface;
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\ConstraintViolationListInterface;
/**
* This class completely overrides `ApiPlatform\Core\Problem\Serializer\ConstraintViolationListNormalizer` class
* since it's final
*
* Goal of overriding is to add `existingUniqueEntities` key when ViolationList contains unique entity violations
*
* @see \ApiPlatform\Core\Problem\Serializer\ConstraintViolationListNormalizer
*/
class ConstraintViolationListNormalizer extends AbstractConstraintViolationListNormalizer implements NormalizerAwareInterface
{
public const FORMAT = 'jsonproblem';
public const TYPE = 'type';
public const TITLE = 'title';
/**
* @var array<string, string>
*/
private $defaultContext = [
self::TYPE => 'https://tools.ietf.org/html/rfc2616#section-10',
self::TITLE => 'An error occurred',
];
/**
* @var ResourceMetadataFactoryInterface
*/
private $resourceMetadataFactory;
/**
* @var SerializerInterface
*/
private $serializer;
/**
* @var NormalizerInterface
*/
private $normalizer;
public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, array $serializePayloadFields = null, NameConverterInterface $nameConverter = null, array $defaultContext = [])
{
parent::__construct($serializePayloadFields, $nameConverter);
$this->resourceMetadataFactory = $resourceMetadataFactory;
$this->defaultContext = array_merge($this->defaultContext, $defaultContext);
}
public function setNormalizer(NormalizerInterface $normalizer): void
{
$this->normalizer = $normalizer;
}
/**
* @param mixed $object
* @param string|null $format
* @param array $context
*
* @return array
*/
public function normalize($object, $format = null, array $context = []): array
{
[$messages, $violations] = $this->getMessagesAndViolations($object);
$response = [
'type' => $context[self::TYPE] ?? $this->defaultContext[self::TYPE],
'title' => $context[self::TITLE] ?? $this->defaultContext[self::TITLE],
'detail' => $messages ? implode("\n", $messages) : (string) $object,
'violations' => $violations,
];
$existingUniqueEntities = $this->getExistingUniqueEntities($object);
return \count($existingUniqueEntities) > 0 ?
array_merge($response, ['existingUniqueEntities' => $existingUniqueEntities])
: $response;
}
private function getExistingUniqueEntities(ConstraintViolationListInterface $constraintViolationList): array
{
$existingUniqueEntities = [];
/** @var ConstraintViolation $violation */
foreach ($constraintViolationList as $violation) {
$constraint = $violation->getConstraint();
if (!$constraint instanceof UniqueEntity) {
continue;
}
$rootEntity = \is_object($violation->getRoot()) ? $violation->getRoot() : null;
if ($rootEntity === null) {
continue;
}
$existingEntityCausedViolation = $violation->getCause()[0];
$metadata = $this->resourceMetadataFactory->create(\get_class($existingEntityCausedViolation));
// get normalization groups for `GET /resource` operation, fallback to global resource groups
$normalizationContext = $metadata->getItemOperationAttribute('get', 'normalization_context', [], true);
$groups = $normalizationContext['groups'] ?? [];
$entityNormalizationContext = \count($groups) > 0 ? ['groups' => $groups] : [];
$existingUniqueEntities[] = [
'uniquePropertyPaths' => $constraint->fields,
'entity' => $this->normalizer->normalize($existingEntityCausedViolation, null, $entityNormalizationContext),
];
}
return $existingUniqueEntities;
}
}
因此,此解决方案基于Symfony验证器和“侦听”
唯一有效期。如果有这样的违规行为,这
normalizer将已经存在的实体添加到响应中
希望有帮助
我已经尝试过这个解决方案,但仍然得到一个唯一的约束错误,解决方案中是否缺少使其工作所需的任何内容?
<?php
declare(strict_types=1);
namespace App\Serializer;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Serializer\AbstractConstraintViolationListNormalizer;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\SerializerInterface;
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\ConstraintViolationListInterface;
/**
* This class completely overrides `ApiPlatform\Core\Problem\Serializer\ConstraintViolationListNormalizer` class
* since it's final
*
* Goal of overriding is to add `existingUniqueEntities` key when ViolationList contains unique entity violations
*
* @see \ApiPlatform\Core\Problem\Serializer\ConstraintViolationListNormalizer
*/
class ConstraintViolationListNormalizer extends AbstractConstraintViolationListNormalizer implements NormalizerAwareInterface
{
public const FORMAT = 'jsonproblem';
public const TYPE = 'type';
public const TITLE = 'title';
/**
* @var array<string, string>
*/
private $defaultContext = [
self::TYPE => 'https://tools.ietf.org/html/rfc2616#section-10',
self::TITLE => 'An error occurred',
];
/**
* @var ResourceMetadataFactoryInterface
*/
private $resourceMetadataFactory;
/**
* @var SerializerInterface
*/
private $serializer;
/**
* @var NormalizerInterface
*/
private $normalizer;
public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, array $serializePayloadFields = null, NameConverterInterface $nameConverter = null, array $defaultContext = [])
{
parent::__construct($serializePayloadFields, $nameConverter);
$this->resourceMetadataFactory = $resourceMetadataFactory;
$this->defaultContext = array_merge($this->defaultContext, $defaultContext);
}
public function setNormalizer(NormalizerInterface $normalizer): void
{
$this->normalizer = $normalizer;
}
/**
* @param mixed $object
* @param string|null $format
* @param array $context
*
* @return array
*/
public function normalize($object, $format = null, array $context = []): array
{
[$messages, $violations] = $this->getMessagesAndViolations($object);
$response = [
'type' => $context[self::TYPE] ?? $this->defaultContext[self::TYPE],
'title' => $context[self::TITLE] ?? $this->defaultContext[self::TITLE],
'detail' => $messages ? implode("\n", $messages) : (string) $object,
'violations' => $violations,
];
$existingUniqueEntities = $this->getExistingUniqueEntities($object);
return \count($existingUniqueEntities) > 0 ?
array_merge($response, ['existingUniqueEntities' => $existingUniqueEntities])
: $response;
}
private function getExistingUniqueEntities(ConstraintViolationListInterface $constraintViolationList): array
{
$existingUniqueEntities = [];
/** @var ConstraintViolation $violation */
foreach ($constraintViolationList as $violation) {
$constraint = $violation->getConstraint();
if (!$constraint instanceof UniqueEntity) {
continue;
}
$rootEntity = \is_object($violation->getRoot()) ? $violation->getRoot() : null;
if ($rootEntity === null) {
continue;
}
$existingEntityCausedViolation = $violation->getCause()[0];
$metadata = $this->resourceMetadataFactory->create(\get_class($existingEntityCausedViolation));
// get normalization groups for `GET /resource` operation, fallback to global resource groups
$normalizationContext = $metadata->getItemOperationAttribute('get', 'normalization_context', [], true);
$groups = $normalizationContext['groups'] ?? [];
$entityNormalizationContext = \count($groups) > 0 ? ['groups' => $groups] : [];
$existingUniqueEntities[] = [
'uniquePropertyPaths' => $constraint->fields,
'entity' => $this->normalizer->normalize($existingEntityCausedViolation, null, $entityNormalizationContext),
];
}
return $existingUniqueEntities;
}
}
# src/Kernel.php
class Kernel extends BaseKernel implements CompilerPassInterface
{
private const CONSTRAINT_VIOLATION_LIST_NORMALIZER_PRIORITY = -780;
...
public function process(ContainerBuilder $container)
{
...
$constraintViolationListNormalizerDefinition = new Definition(
ConstraintViolationListNormalizer::class,
[
$container->getDefinition('api_platform.metadata.resource.metadata_factory.cached'),
$container->getParameter('api_platform.validator.serialize_payload_fields'),
$container->hasDefinition('api_platform.name_converter') ? $container->getDefinition('api_platform.name_converter') : null,
[],
]
);
$constraintViolationListNormalizerDefinition->addTag('serializer.normalizer', ['priority' => self::CONSTRAINT_VIOLATION_LIST_NORMALIZER_PRIORITY]);
$container->setDefinition('api_platform.problem.normalizer.constraint_violation_list', $constraintViolationListNormalizerDefinition);
}