Uma enumeração de valores aceitos
Um enum é um conjunto fechado de valores permitidos para uma variável ou entrada. A forma de declarar e aplicar esse conjunto depende da linguagem ou do formato. No JSON Schema, a palavra-chave enum recebe uma lista de valores permitidos e o validador verifica se a entrada corresponde a algum deles.
Essa validação pode limitar o estado de um artigo a "rascunho" ou "publicado". Uma entrada como "arquivado" é recusada mesmo sendo um texto, porque a validação compara o valor recebido com as opções declaradas. A enumeração também não implementa a ação de publicar o artigo: ela apenas restringe os valores aceitos.
O tipo faz parte do valor
O exemplo didático a seguir é um schema para validar um valor isolado. A lista aceita um número, um texto específico e o valor nulo:
{ "enum": [1, "ativo", null]}O número 1 passa pela validação. A string "1" é recusada porque contém texto e não corresponde ao número da lista. O texto "ativo" e o valor null são aceitos, mas "inativo" e 2 ficam fora do conjunto. Essa diferença permite que você localize uma recusa causada pelo tipo recebido, mesmo quando a representação na tela parece semelhante.
A palavra-chave não converte a entrada para outro tipo. Uma conversão configurada no validador ou feita pela aplicação é uma etapa adicional. Ao investigar uma recusa, confira o valor recebido e a configuração usada para validá-lo.
Presença do campo e comportamento da aplicação
Num schema de objeto, um enum dentro de properties limita o valor de uma propriedade presente. Para exigir que o campo seja enviado, você precisa incluí-lo também em required. A enumeração não substitui essa exigência.
Adicionar uma opção à lista permite que ela passe pela validação, mas o programa precisa saber o que executar ao recebê-la. Um enum declarado numa linguagem como TypeScript tem sintaxe e comportamento próprios. A explicação do JSON Schema não define como essa linguagem representa a enumeração durante a execução.
Dúvidas frequentes
Perguntas frequentes sobre enum
- Um enum aceita somente textos?
- A palavra-chave enum do JSON Schema pode listar valores de tipos diferentes. Uma declaração de type no mesmo schema pode restringir quais desses valores serão aceitos.
- O texto "1" equivale ao número 1?
- A string "1" e o número 1 são valores diferentes no JSON Schema. Um validador que converte tipos por configuração própria acrescenta um comportamento que não pertence à palavra-chave enum.
- Um enum torna obrigatório o campo de um objeto?
- A enumeração limita o valor quando o campo está presente. No JSON Schema, exigir a presença de uma propriedade de objeto requer também a declaração correspondente em required.
Para continuar
Recursos relacionados
Documentação
JSON Schema: valores enumerados
Referência do JSON Schema com exemplos de enumerações de texto e de listas que misturam tipos.
Abrir recursoSite de referência
DevSide: desenvolvimento colaborativo
Sessão prática para você revisar a validação de entradas e conferir como a aplicação trata cada opção permitida.
Abrir recursoDocumentação
JSON Schema: propriedades obrigatórias de objetos
Explicação de required e da diferença entre validar o valor e exigir a presença de uma propriedade.
Abrir recursoAplicação na formação
Vibe Coding: Do Zero ao MVP
Você pode conferir se a validação de entradas aceita somente as opções que a aplicação sabe processar.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.