Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Serializer documentation can be improved (possibly contains an error?)

Abierto
#2,280 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
php, symfony

Línea de trabajo

Comienza con la página de documentación de Symfony Serializer, especialmente con la sección sobre cómo cambiar el contexto de serialización por elemento y su ejemplo de decorador. Verifica el comportamiento de almacenamiento en caché de getSupportedTypes y compáralo con la alternativa escalable propuesta; se considera terminado cuando ambos ejemplos sean técnicamente correctos y la documentación explique claramente cuándo usar cada enfoque.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

2 part question, both relating to (Symfony) Serializer docs.

1:
The Serializer docs show an example of decorating the json-ld normalizer to add a few fields, but wouldn't a completely custom serializer be better so the getSupportedTypes can be used to efficiently decide if this serializer should be used instead of having 20,30, maybe 100s of services decorating the json-ld normalizer and it having to go through all those layers with like if (!$data instanceof ...) or if (!is_a($type, SomeClass::class, true))

Should we add an example for a cache-able/scalable solution that doesn't involve decorating the json-ld one?

2:
Then looking at the example code here:
https://api-platform.com/docs/core/serialization/#changing-the-serialization-context-on-a-per-item-basis-for-symfony

Specifically:

    public function supportsNormalization($data, $format = null, array $context = [])
    {
        // Make sure we're not called twice
        if (isset($context[self::ALREADY_CALLED])) {
            return false;
        }

        return $data instanceof Book;
    }

    public function getSupportedTypes(?string $format): array
    {
        return [
            Book::class => true
        ];
    }

Returning true on getSupportedTypes means the usage of the serializer gets cached, and the supportsNormalization method is only checked once, then never again. So adding the self::ALREADY_CALLED in the normalize method doesn't do anything,... next time it goes through this normalizer, the supportsNormalization is skipped and boom, it now executed normalize on an item that has possibly already gone through it?

I can contribute a change for both things, but would like to get a second opinion first to see if I'm maybe missing something.

Lenguaje dominante
Sin datos de lenguaje
Estrellas
181
Forks
1.1k
Merge medio
1 d 10 h
PR fusionados (30 d)
24

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de api-platform/docs

Todos los issues de api-platform/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.