Add support for the @Ignore annotation #1566
Comments
|
+1, as mentioned in https://symfony.com/blog/new-in-symfony-5-1-serializer-improvements#added-ignore-annotation a PR symfony/symfony#28744 done by @dunglas add an Is there a specific way to use it in api-platform ? (because this PR was done by the api-platform creator on the Symfony edge, it seems strange that doesn't work on api-platform side) |
|
It was indeed my intent to support it in API Platform too, but I didn’t have the time to do the PR yet. Any help on this will be very appreciated! |
|
@dunglas I can take a look at this, but I don't really know where to start. I thought that api-platform use the symfony serializer then take care of it automaticaly. |
|
I would love to see this in API-P, I will try to work on it ! I have (as mpiot) no clue about where to start except I will modify test so it fit the needs here, then I will fix the test by modifying the code. |
|
Quick n' dirty this is what I did to add support. I guess this should live in App\Api\OpenapiSchema\SerializationIgnoreExtractor:
decorates: api_platform.metadata.property.metadata_factory
decoration_priority: 22
arguments: [ '@serializer.mapping.class_metadata_factory','@.inner' ]
autowire: false<?php
namespace App\Api\OpenapiSchema;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
final class SerializationIgnoreExtractor implements PropertyMetadataFactoryInterface
{
private PropertyMetadataFactoryInterface $decorated;
private ClassMetadataFactoryInterface $serializerClassMetadataFactory;
public function __construct(ClassMetadataFactoryInterface $serializerClassMetadataFactory, PropertyMetadataFactoryInterface $decorated)
{
$this->serializerClassMetadataFactory = $serializerClassMetadataFactory;
$this->decorated = $decorated;
}
/**
* {@inheritdoc}
*/
public function create(string $resourceClass, string $property, array $options = []): PropertyMetadata
{
$propertyMetadata = $this->decorated->create($resourceClass, $property, $options);
$serializerClassMetadata = $this->serializerClassMetadataFactory->getMetadataFor($resourceClass);
if(
isset($serializerClassMetadata->getAttributesMetadata()[$property]) &&
$serializerClassMetadata->getAttributesMetadata()[$property]->isIgnored()
){
$propertyMetadata = $propertyMetadata->withWritable(false)->withReadable(false);
}
return $propertyMetadata;
}
} |
|
It's supported in API Platform 2.6! |
|
@dunglas as this is implemented in AbstractItemNormalizer it is supported when retrieving stuff from the API but the schema still exposes the ignored properties. |
|
@lucasgranberg got it. Would you mind to open a PR? It's indeed better to strip these properties at the schema level. The other patch should be reverted. |
|
I could give it a shot but I need some pointers. Is Looking at AbstractItemNormalizer it looks like I should do if (
$this->isAllowedAttribute($classOrObject, $propertyName, null, $context) &&
(
isset($context['api_normalize']) && $propertyMetadata->isReadable() ||
isset($context['api_denormalize']) && ($propertyMetadata->isWritable() || !\is_object($classOrObject) && $propertyMetadata->isInitializable())
)
) {
$allowedAttributes[] = $propertyName;
}Also, is this code supposed to go in symfony bridge as it has to do with symfony/serializer? |
|
I think the ignored properties should be totally removed from the collection |
|
The best thing would probably be if it was handled in symfony propertyinfo directly. There is code for it in symfony 5.2 but int only triggers if there is serialization groups: |
|
Ignore that, it already works with symfony 5.2! |
it does ? Adding test would be useful or that's like duplicating Symfony/Validator tests ? |
|
Oh no... I still had my "hack" implemented so thats why I thought it worked. I do not fully understand how api-platform uses propertyinfo but it should work since symfony 5.2 allows null as serialization group. |
|
I did this PR: |
Description
Symfony 5.1 brought us the @ignore annotation but it's not supported yet here.
Example
It allows to create a method for example that you don't want to expose in the API without using the Groups annotation
The text was updated successfully, but these errors were encountered: