Guia Prático

JSON Schema - Mini Guia

Aprenda a criar schemas eficazes para estruturar os dados extraídos pelas suas automações.

O que é JSON Schema?

JSON Schema é uma linguagem declarativa que permite definir a estrutura, formato e validação de dados JSON. No contexto das automações Getno, ele define exatamente como os dados extraídos devem ser organizados e retornados.

Por que usar?

• Estrutura previsível: garante que os dados sempre sigam o mesmo formato
• Validação automática: evita dados inconsistentes ou malformados
• Documentação viva: serve como documentação da estrutura de dados
• Facilita integração: outros sistemas sabem exatamente o que esperar

Estrutura Básica

Schema para dados de uma pessoa

Schema JSON

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "nome": {
      "type": "string",
      "description": "Nome completo da pessoa"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Endereço de email válido"
    },
    "idade": {
      "type": "integer",
      "minimum": 0,
      "maximum": 150,
      "description": "Idade em anos"
    }
  },
  "required": ["nome", "email"],
  "additionalProperties": false
}

Dados que este schema aceita:

Exemplo de resposta válida

{
  "nome": "Maria Silva",
  "email": "maria@example.com",
  "idade": 30
}

Tipos de Dados Suportados

Tipos Básicos

stringTexto

numberNúmeros decimais

integerNúmeros inteiros

booleantrue/false

arrayListas

objectObjetos aninhados

Formatos Especiais

emailE-mail válido

uriURL válida

dateData (YYYY-MM-DD)

date-timeData e hora ISO

uuidUUID válido

🎯 Boas Práticas

Recomendações

1. Seja específico com tipos

Use integer para números inteiros, number para decimais

2. Defina campos obrigatórios

Use required para campos essenciais

3. Adicione descrições

Use description para documentar cada campo

4. Use formatos quando possível

Email, URI, date-time garantem dados válidos

5. Limite propriedades extras

Use "additionalProperties": false para estrutura rígida

6. Valide intervalos numéricos

Use minimum, maximum para limitar valores

💡 Dica importante: Mantenha nomes de campos e tipos coerentes com o que a automação realmente extrai. Se o site sempre retorna preços como string "R$ 99,90", considere isso no seu schema ou nas instruções da automação.

🛠️ Ferramentas Úteis

Ferramentas para ajudar na criação e validação de schemas:

Documentação