Defina um esquema para um modelo

Um esquema é uma classe Python que lista os campos que seus dados devem ter. Ele reflete um modelo, mas existe separadamente, apenas para entrada e saída.

Todo esquema herda da classe base Schema do Marshmallow. Dar a ele o nome do seu modelo, como UserSchema, deixa a intenção evidente de imediato.

Dentro da classe, você adiciona atributos do módulo fields. Cada um nomeia uma chave que aparecerá na saída JSON serializada.

Escolha um tipo de campo que corresponda aos dados: Int, Str, Bool, Float ou DateTime. O tipo controla como os valores são formatados e validados.

Um campo DateTime serializa automaticamente os datetimes do Python em strings ISO limpas. Não é mais necessário espalhar formatações manuais pelas suas visualizações.

Passe required=True para um campo para que o carregamento falhe se ele estiver ausente. Esta é sua primeira experiência com a validação incorporada diretamente ao esquema.

Liste apenas os campos que deseja expor. Ao simplesmente não declarar password_hash, o esquema nunca poderá vazá-lo em uma resposta.

Quer JSON em camelCase a partir de um atributo snake_case? Use data_key para mapear um nome interno para uma chave externa diferente.

Alguns campos, como um id, devem aparecer na saída, mas nunca ser aceitos como entrada. Marque-os como dump_only para mantê-los somente para leitura.

Crie uma instância para reutilizar: user_schema é igual a UserSchema(). Mais tarde, passe many=True ao serializar uma lista inteira.

Essa única classe converterá modelos em JSON e também carregará JSON de volta em dados verificados. Você define a estrutura uma vez e a usa nos dois sentidos.

Uma subclasse de Schema declara campos tipados que correspondem ao seu modelo. Opções como required, dump_only e data_key definem exatamente o que entra e o que sai.