Zaia Docs
APIZaia AcademyComunidade no Discord
API
API
  • Introdução
    • Fundamentos APIS
      • 1.O que é um JSON e sua importância
      • 2.O Que é um Webhook?
      • 3.O Que é cURL?
      • 4.O Que é uma API?
  • Chat Generativo Externo
    • [GET] Buscar chat
    • [GET] Buscar múltiplos chats
    • [POST] Criar novo chat
  • Mensagem Generativa Externa
    • [PATCH] Resolve Takeover
    • [POST] Create
    • [GET] Retrieve Multiple
  • Mensagem entre canais
    • [POST] Envio de texto e imagem externas
  • Agente
    • [POST] Criar agente
    • [PATCH] Atualizar agente
    • [DELETE] Excluir agente
    • [GET] Buscar agentes
  • Estágios do Agente
    • [POST] Criar um estágio
    • [PATCH] Reorganizar estágios
    • [DELETE] Remover estágio
    • [GET] Listar estágios
    • [PATCH] Atualizar
  • Requisições HTTP de Estágio de Chat
    • [DELETE] Remover
    • [GET] Recuperar Múltiplos
    • [GET] Recuperar
    • [PATCH] Atualizar
  • Cérebro
    • [POST] Criar Crawler
    • [DELETE] Remover Crawler
    • [DELETE] Remover Múltiplos Crawlers
    • [POST] Treinar Crawler
    • [GET] Recuperar Múltiplos Crawlers
    • [POST] Treinar Arquivo
    • [DELETE] Remover Arquivo
    • [DELETE] Remover Múltiplos Arquivos
    • [GET] Recuperar Múltiplos Arquivos
  • Mensagem Generativa Efêmera
  • Consumo
Fornecido por GitBook
Nesta página
  • O Que é JSON?
  • 📖 Analogia 1: O Cardápio de um Restaurante
  • 📖 Analogia 2: A Receita de um Bolo
  • 🛠️ Por Que Usamos { }, [ ] e : em JSON?
  • 🛠️ Quando Usar Vírgulas e Aspas no JSON?
  1. Introdução
  2. Fundamentos APIS

1.O que é um JSON e sua importância

O Que é JSON?

JSON (JavaScript Object Notation) é um formato de dados leve e amplamente utilizado para armazenar e trocar informações entre sistemas. Ele é muito usado em APIs porque é fácil de ler e interpretar tanto por humanos quanto por computadores.

📖 Analogia 1: O Cardápio de um Restaurante

Imagine que JSON é como o cardápio de um restaurante. Ele organiza as informações de forma clara, separando as categorias (entradas, pratos principais e sobremesas). Quando um cliente quer saber quais pratos estão disponíveis, basta olhar o cardápio.

Agora veja um exemplo de JSON que representa um menu de restaurante:

{
  "restaurante": "Pizzaria do João",
  "menu": {
    "pizza": "Calabresa",
    "preco": 39.90,
    "tamanho": "Grande"
  }
}

Neste JSON, temos um restaurante que vende pizza de calabresa por R$39,90 no tamanho grande. O JSON organiza as informações de forma que qualquer sistema possa entender.

📖 Analogia 2: A Receita de um Bolo

Agora, imagine que JSON é como uma receita de bolo. Ele lista os ingredientes e suas quantidades de maneira organizada, permitindo que qualquer pessoa (ou sistema) siga as instruções.

{
  "receita": "Bolo de Chocolate",
  "ingredientes": [
    {"item": "Farinha", "quantidade": "2 xícaras"},
    {"item": "Açúcar", "quantidade": "1 xícara"},
    {"item": "Chocolate em pó", "quantidade": "1/2 xícara"},
    {"item": "Ovos", "quantidade": 3},
    {"item": "Leite", "quantidade": "1 xícara"}
  ],
  "tempo_preparo": "40 minutos"
}

Aqui, temos um JSON estruturado para armazenar uma receita. Esse formato permite que qualquer sistema leia, armazene e processe informações de maneira eficiente.

🛠️ Por Que Usamos { }, [ ] e : em JSON?

Chaves { }: Representam um objeto. Tudo dentro delas está agrupado em um conjunto de informações. Exemplo:

{
  "nome": "João",
  "idade": 30
}

Aqui, temos um objeto com os dados de João.

Colchetes [ ]: Representam uma lista de itens. Exemplo

{
  "animais": ["cachorro", "gato", "papagaio"]
}

Aqui, temos uma lista de animais.

Dois pontos :: Separam chaves e valores. Exemplo:

{
  "cidade": "Rio de Janeiro"
}

Uma chave equivale a um campo ou uma variável de um sistema. Então nesse caso o sistema entende que "cidade"tem o valor "Rio de Janeiro".

Esses elementos ajudam a estruturar e organizar os dados de maneira clara e compreensível.

🛠️ Quando Usar Vírgulas e Aspas no JSON?

Saber quando usar vírgulas e aspas no JSON é essencial para evitar erros ao manipular e interpretar arquivos JSON.

🔍 Aspas (" "): Quando Usar?

  • Sempre usar aspas em chaves (nomes dos atributos)

  • Sempre usar aspas em valores do tipo texto (string)

  • Números, valores booleanos (true ou false) e null não precisam de aspas

✅ Correto:

{
  "nome": "João",
  "idade": 30,
  "email": "joao@email.com",
  "ativo": true,
  "saldo": 100.50,
  "endereco": null
}

Aqui:

  • "nome", "email" e "endereco" são textos, então precisam de aspas.

  • 30, 100.50 e true são números e booleanos, então não precisam de aspas.

  • null é um valor especial e não precisa de aspas.

❌ Errado:

{
  nome: "João", 
  "idade": "30",
  "email": joao@email.com,
  "ativo": "true"
}

Erros:

  • nome está sem aspas ❌

  • idade deveria ser um número sem aspas ❌

  • email precisa de aspas ❌

  • ativo deveria ser um booleano sem aspas ❌

🔍 Vírgulas ( , ): Quando Usar?

  • Sempre usar vírgula entre pares de chave/valor em um objeto JSON.

  • Nunca usar vírgula após o último item da lista ou do objeto.

✅ Correto:

{
  "id": 1,
  "nome": "Notebook",
  "preco": 2999.99
}

Aqui, cada item é separado por uma vírgula, exceto o último.

❌ Errado:

{
  "id": 1,
  "nome": "Notebook",
  "preco": 2999.99,
}

❌ Erro: A última vírgula não deveria estar ali.

O mesmo vale para listas em JSON:

✅ Lista Correta:

{
  "categorias": ["eletrônicos", "móveis", "brinquedos"]
}

❌ Errado:

{
  "categorias": ["eletrônicos", "móveis", "brinquedos",]
}

❌ Erro: A última vírgula depois de "brinquedos" não deveria estar ali.

AnteriorFundamentos APISPróximo2.O Que é um Webhook?

Atualizado há 2 meses