Como montar e conferir um payload JSON para uma API

Vamos preparar um corpo de requisição para um endpoint fictício que filtra pedidos. O contrato do exemplo exige um objeto com a propriedade codigos, um array de strings, e incluirInativos, um booleano. Os códigos 00042 e 00103 têm zeros à esquerda que fazem parte do identificador.

1. Gere o array com os códigos alfanuméricos

Cole os dois primeiros códigos em Lista para JSON. Veja que o resultado mantém as aspas. Ao testar 00042 sozinho, a ferramenta retorna o número 42 por inferência de tipo. Para os códigos formados apenas por dígitos, copie o valor original e escreva a string diretamente entre aspas no corpo da requisição.

Abrir Lista para JSON

Entrada para Lista para JSON
PED-031
PED-107
Array gerado
[
  "PED-031",
  "PED-107"
]

2. Monte o objeto e confira a sintaxe

Combine os quatro códigos no campo codigos e inclua o valor false sem aspas em incluirInativos. Cole o objeto no Formatador e validador JSON. Para reproduzir um erro comum, coloque uma vírgula depois de 00103, antes de fechar o array. Remova a vírgula para voltar ao resultado abaixo.

Abrir Formatador e validador JSON

Corpo JSON válido
{
  "codigos": [
    "PED-031",
    "PED-107",
    "00042",
    "00103"
  ],
  "incluirInativos": false
}

3. Confira o contrato com um caso que deve falhar

Experimente trocar false por "false" na ferramenta. O JSON ainda passa na validação de sintaxe, mas o endpoint do exemplo espera um booleano. Guarde o payload correto e essa variante como entradas de teste. No ambiente de teste da API, confira se uma é aceita e a outra recebe o erro de validação previsto no contrato.

JSON válido com o tipo errado
{
  "codigos": ["PED-031", "PED-107", "00042", "00103"],
  "incluirInativos": "false"
}

O que conferir no seu caso

  • Confira se o contrato espera um objeto com codigos ou um array na raiz. As duas formas podem ser JSON válido.
  • Compare os identificadores com a origem após a formatação. Um identificador convertido em número perde os zeros à esquerda.