Skip to content

MarkEhr/tide-serialization-groups-rules

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

Reglas para definir grupos de serialización en Symfony

Para proyectos desarrollados dentro de TIDE

  1. Los nombres serán definidos en snake case y en inglés

  2. Todas las entidades tienen un grupo base, definido como {nombre_de_la_entidad}_read

    • El grupo base estará en todas las propiedades públicas que no sean relaciones (e.g. string, int, boolean, etc. ).
    • Propiedades públicas hace referencia a las propiedades que quieran ser expuestas en el api, no a que hayan sido declaradas como públicas.
  3. Por cada propiedad que contenga una relación, se definirá un grupo de serialización nuevo con el nombre {nombre_de_la_entidad}_read_{nombre_de_la_propiedad}

  4. Las propiedades deberán tener un solo grupo de serialización de lectura y uno de escritura.

  5. Todos los grupos requeridos para escribir o leer la entidad en el caso más común del endpoint serán incluidos en el normalization_context o denormalization_context configurado para la entidad. Si se requieren agregar más propiedades a la serialización, los grupos no se agregan en la propiedad, si no que el grupo único que tiene la propiedad deberá ser agregado a la configuración de la entidad.

  6. Aún cuando se editen entidades ya hechas que no sigan esta guía, las nuevas propiedades que se les agreguen deberán seguir esta guía.

Todas las reglas aplican para grupos de normalización y des-normalización. Únicamente cambiar la palabra read por write para des-serialización

About

Reglas para definir grupos de serialización en Symfony

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published