Entendendo O Formato Json

Um formato JSON (JavaScript Object Notation) é um formato de dados leve e fácil de ler que é amplamente utilizado para representar e trocar informações entre sistemas. A estrutura de um formato JSON é bastante simples e consiste em pares chave-valor organizados em objetos e arrays.

Estrutura de um Formato JSON

Objetos JSON

Um objeto JSON é delimitado por chaves {}.
Ele consiste em pares chave-valor separados por vírgulas.
A chave é uma string (entre aspas duplas) que identifica o valor associado.
O valor pode ser de vários tipos, incluindo números, strings, booleanos, objetos JSON aninhados ou arrays.

Exemplo de um objeto JSON:

JSON

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

Arrays JSON

Um array JSON é delimitado por colchetes [].

Ele contém valores separados por vírgulas.
Os valores em um array podem ser de qualquer tipo JSON, incluindo outros objetos JSON ou arrays.

Exemplo de um array JSON:

JSON

{
    "pessoa": {
        "nome": "Maria",
        "idade": 25
    },
    "amigos": [
        {
            "nome": "Carlos",
            "idade": 28
        },
        {
            "nome": "Ana",
            "idade": 22
        }
    ]
}

Comentários

Diferentemente de outros formatos, como XML, o JSON não suporta comentários. Comentários não são permitidos em arquivos JSON padrão.

Exemplo de Estrutura Completa de JSON

Exemplo detalhado:

JSON

{
    "revendedora": "Carros Inc.",
    "localizacao": {
        "cidade": "Cidade A",
        "estado": "Estado X"
    },
    "estoque": [
        {
            "marca": "Toyota",
            "modelos": [
                {
                    "nome": "Corolla",
                    "ano": 2022,
                    "cores_disponiveis": ["preto", "prata", "branco"],
                    "quantidade": 10
                },
                {
                    "nome": "Camry",
                    "ano": 2023,
                    "cores_disponiveis": ["azul", "vermelho", "cinza"],
                    "quantidade": 5
                }
            ]
        },
        {
            "marca": "Honda",
            "modelos": [
                {
                    "nome": "Civic",
                    "ano": 2022,
                    "cores_disponiveis": ["prata", "preto"],
                    "quantidade": 7
                },
                {
                    "nome": "Accord",
                    "ano": 2023,
                    "cores_disponiveis": ["branco", "vermelho"],
                    "quantidade": 3
                }
            ]
        }
    ]
}

Explicação de cada elemento do JSON:

Revendedora: É uma chave que contém o nome da revendedora de carros, que é "Carros Inc.".

Localização: É um objeto que contém informações sobre a localização da revendedora.

- cidade: É uma chave que contém o nome da cidade, que é "Cidade A".
- estado: É uma chave que contém o nome do estado, que é "Estado X".

Estoque: É uma lista que contém objetos representando marcas de carros disponíveis na revendedora.

Cada objeto na lista tem duas chaves:
- Marca: Contém o nome da marca (por exemplo, "Toyota" ou "Honda").
- Modelos: É uma lista de objetos representando modelos de carros daquela marca.
- Cada objeto de modelo contém informações como o nome do modelo, o ano de fabricação, as cores disponíveis e a quantidade em estoque.

Revendedores: É uma lista que contém objetos representando os revendedores da empresa.

Cada objeto de revendedor contém informações sobre o nome, o contato (por exemplo, endereço de e-mail) e a lista de carros que o revendedor vendeu.
A lista de carros vendidos é uma lista de objetos, cada um contendo a marca, o modelo e o ano do carro vendido por esse revendedor.

Em resumo, este JSON representa uma revendedora de carros chamada Carros Inc. com informações sobre sua localização, seu estoque de carros (incluindo marcas, modelos, cores e quantidade em estoque) e informações sobre seus revendedores (incluindo nomes, contatos e carros vendidos por cada revendedor). Essa estrutura hierárquica e aninhada é útil para organizar informações complexas relacionadas à revendedora de carros em um formato facilmente legível e acessível.

Outra forma de entender é separando os itens pela estrutura:

No exemplo fornecido, os itens entre chaves {} representam objetos JSON, e os itens entre colchetes [] representam arrays JSON. Veja com mais detalhes:

Itens entre {} (chaves):

Os itens entre chaves {} são objetos JSON.
Cada par de chaves {} delimita um objeto JSON.
Um objeto JSON é uma coleção de pares chave-valor, onde as chaves são strings (entre aspas duplas) que identificam os valores associados.
Por exemplo:
- "localizacao" é um objeto com as chaves "cidade" e "estado".
- "modelos" é um objeto com as chaves "nome", "ano", "cores_disponiveis", e "quantidade".

Itens entre [] (colchetes):

Um array JSON é uma lista ordenada de valores.
Os itens entre colchetes [] são arrays JSON.
Cada par de colchetes [] delimita um array JSON.
Por exemplo:
- estoque é um array que contém dois objetos JSON (representando marcas de carros).
- modelos é um array que contém objetos JSON (representando modelos de carros disponíveis).
- carros_vendidos é um array que contém objetos JSON (representando carros vendidos por revendedores).

Em resumo, no JSON fornecido, os objetos são delimitados por {} e contêm pares chave-valor, enquanto as listas são delimitadas por [] e contêm valores em uma ordem específica. Essa estrutura é usada para representar dados complexos e hierárquicos de maneira organizada.

Como configurar na cVortex

Dica

Veja um exemplo de como Cadastrar uma API.