Serializers - Retornando o que você quer na API

Transcript

1. Serializers Retornando o que você quer na API
2. Sobre mim • Dev a 5 anos na • Gosto de hambúrguer • Main Jamie no Street Fighter 6
3. Objetivos • Dar um overview mais básico sobre Serializers • Não entrar em muitas complexidades para não assustar novatos
4. O que é um serializer? • Converter nossos dados do banco de dados para um JSON legível para o usuário • Filtra os dados que repassamos para o cliente
5. Por que filtrar os dados? • Muitas vezes o que tem no nosso código não é o que queremos passar pro usuário, por exemplo senhas e endereços:
6. Por que filtrar os dados? • Outras vezes temos um monte de atributos que não queremos passar adiante e queremos tirar eles fora
7. Por que filtrar os dados? • Então temos que mudar os dados que recebemos para responder ao nosso usuário:
8. Maneira mais fácil: criar um hash e dar “.to_json” Pros: • Não precisa instalar nada • O módulo JSON já é padrão do ruby Contras: • Fica mais difícil trabalhar com grandes quantidades de dados • Não é bonito
9. Opções em Ruby • ActiveModelSerializers -> uma das gems mais populares, atua com o ActiveModel • jsonapi-rb -> altamente performatica, usa a JSON:API • fast_jsonapi -> serializer focado em velocidade • jsonapi-resources -> focado em tornar o rails compativel com o JSON:API • blueprinter -> criado pelo Procore, feito para ser simples, direto e performático • Alba -> Rápido, fácil e agnóstico, com o adicional de ser capaz de manipulação de erros • O serializer do próprio rails -> Que eu nem sabia que existia
10. Apesar de termos muitas opções • Todas elas buscam fazer as mesmas coisas • Como uma provavelmente se inspirou na outra, métodos básicos são os mesmos
11. Explicar uma ajuda a explicar várias Por isso eu vou usar o ActiveModelSerializer
12. Nosso modelo a ser serializado Algumas gems serializam quase qualquer classe, algumas outras nos oferecem uma classe “serializável” como o exemplo abaixo, mas geralmente tentam compatibilizar com os models do Rails
13. Criar um serializer é simples
14. ::attributes chamam métodos na sua classe
15. Mas também podemos usar métodos do próprio Serializer
16. Podemos ser mais específicos diretamente com ::attribute
17. Lembrando que Apesar da implementação parecer específica, outras gems também implementam de forma parecida
18. Podemos também cuidar de nossas associações
19. E sinceramente, isso é tudo que precisamos para começar
20. Mas Fabricio, como chamamos esses serializers?
21. O Rails procura o serializer pra gente, mas podemos passar um específico
22. Também podemos chamar sem precisar passar pelo controller
23. E finalmente, podemos passar parâmetros externos
24. Outras opções
25. jsonapi-rb
26. jsonapi-serializer
27. JSONAPI::Resources
28. blueprinter
29. Alba
30. Conclusão Usem serializers
31. Links, Gems e Guias Gem ActiveModelSerializer - https://github.com/rails-api/active_model_serializers/tree/0-10-stable Guia do ActiveModelSerializer - https://github.com/rails-api/active_model_serializers/blob/0-10-stable/docs/README.md Guia do JSONAPI-RB - https://jsonapi-rb.org/ Guia do jsonapi-serializer - https://github.com/jsonapi-serializer/jsonapi-serializer Guia do JSONAPI::Resources - https://jsonapi-resources.com/ Guia do Blueprinter - https://github.com/procore/blueprinter Guia do Alba - https://github.com/okuramasafumi/alba