Ao trabalhar com APIs, é essencial entender como enviar vários tipos de dados com suas requisições. O Apidog fornece uma interface amigável para ajudar você a construir e enviar requisições de API com diferentes parâmetros e tipos de dados de corpo.Parâmetros#
Os parâmetros permitem que você envie informações adicionais ao servidor. O Apidog oferece suporte a dois tipos principais de parâmetros: Query params e Path params.Query Params#
Os parâmetros de consulta são anexados ao final da URL após um ponto de interrogação (?) e são separados por ampersands (&). Eles são usados para enviar dados opcionais ou adicionais ao servidor.No Apidog, você tem duas maneiras convenientes de adicionar parâmetros de consulta às suas requisições de API:1.
Diretamente na URL: Você pode anexar parâmetros de consulta diretamente ao final da URL na barra de endereço. Por exemplo:https://api.example.com/users?page=1&limit=10
2.
Usando a seção Query Params: O Apidog fornece uma seção dedicada de Query Params abaixo do campo de entrada da URL. Aqui, você pode adicionar, editar e remover parâmetros de consulta usando uma interface amigável. Os parâmetros adicionados nessa seção serão automaticamente anexados à URL da requisição.
Sinal de Igual em Query Params#
Em alguns casos especiais, os parâmetros de consulta podem não aparecer como pares de chave-valor. Por exemplo, uma URL de requisição pode ser:https://api.example.com/users?available
available pode servir como um parâmetro com um valor vazio. Quando o valor está vazio, o Apidog omite automaticamente o sinal de igual entre a chave e o valor.Se você não quiser omitir esse sinal de igual, poderá alterá-lo manualmente para "Adicionar um sinal de igual".Path Params#
Os parâmetros de caminho fazem parte do próprio caminho da URL e normalmente são usados para identificar um recurso específico. Eles são indicados por placeholders na URL, geralmente delimitados por chaves {}.https://api.example.com/users/{userId}
{param} será substituído pelo valor real. Esse recurso é particularmente útil ao testar APIs RESTful que usam identificadores de recursos na URL.Se você precisar usar variáveis em parâmetros de caminho, a forma recomendada é primeiro usar {param} na URL e, em seguida, usar {{variable}} no valor do parâmetro.
Corpo#
O corpo da requisição é usado para enviar dados ao servidor como parte de uma requisição POST, PUT ou PATCH. O Apidog oferece suporte a vários formatos de dados de corpo para atender a diferentes requisitos de API.Comparação de Tipos de Corpo#
A tabela a seguir fornece uma comparação rápida dos tipos de corpo disponíveis:| Tipo de Corpo | Content-Type | Caso de Uso | Suporte a Upload de Arquivo |
|---|
| form-data | multipart/form-data | Envios de formulário com arquivos | ✓ Sim |
| x-www-form-urlencoded | application/x-www-form-urlencoded | Envios de formulários simples | ✗ Não |
| JSON | application/json | Troca de dados estruturados | ✗ Não |
| XML | application/xml | Sistemas legados, APIs SOAP | ✗ Não |
| raw | Personalizado (text/plain, etc.) | Formatos de dados personalizados | ✗ Não |
| binary | application/octet-stream | Uploads de arquivos, dados binários | ✓ Sim |
| GraphQL | application/json | Consultas/mutações GraphQL | ✗ Não |
| msgpack | application/msgpack | Transferência de dados de alto desempenho | ✗ Não |
Form-data é uma forma de enviar pares de chave-valor, semelhante ao envio de um formulário HTML. Esse formato é particularmente útil quando você precisa fazer upload de arquivos junto com outros dados.O corpo do tipo form-data será exibido como multipart/form-data na requisição. Para cada parâmetro no corpo, você pode escolher seu tipo, como string, integer, etc.Enviando JSON em form-data: Se você precisar enviar um JSON em form-data, precisará definir o tipo do parâmetro como string e, em seguida, preencher o JSON no campo de string.Enviando arquivos: Se você precisar enviar um arquivo na requisição, selecione o tipo como arquivo e clique em "Upload" para escolher um arquivo local.O Apidog apenas envia o arquivo na requisição, mas não salva o arquivo na nuvem. Portanto, durante a colaboração em equipe, outras pessoas podem ver essa requisição, mas não podem enviar diretamente esse arquivo. Você precisa transferir esse arquivo para seus colegas por outros meios para que eles possam enviá-lo.
JSON#
JSON é um formato de dados amplamente usado para requisições e respostas de API. Você pode projetar o esquema de dados na seção Requisição → Corpo → JSON de um endpoint.Ao projetar um esquema de dados JSON, você pode usar o recurso Gerar a partir de JSON no Apidog para criar rapidamente o esquema em vez de adicionar cada campo manualmente.Ao adicionar campos manualmente, o tipo de dados padrão é string. Se você precisar adicionar campos aninhados, altere o tipo do campo para object ou array.Se você quiser adicionar comentários em JSON, poderá habilitar "Suporte a JSON com comentários" em Configurações → Configurações gerais → Configurações de recursos → Configurações avançadas. Ao enviar JSON, esses comentários serão removidos automaticamente.
XML#
XML (eXtensible Markup Language) é outro formato de dados comum usado em comunicações de API. O Apidog oferece suporte a payloads XML, permitindo que você envie dados estruturados no formato XML com suas requisições de API.raw#
A opção raw permite que você envie qualquer formato de dados personalizado no corpo da requisição. Isso é útil ao trabalhar com APIs que esperam estruturas ou formatos de dados específicos não abrangidos pelas outras opções.binary#
Dados binários podem ser enviados usando esta opção, que é particularmente útil ao fazer upload de arquivos ou trabalhar com APIs que esperam payloads binários. O Apidog permite que você selecione e envie arquivos binários como parte de suas requisições de API.GraphQL#
Para APIs que usam GraphQL, o Apidog fornece um editor GraphQL dedicado. Esse recurso permite que você construa e envie consultas e mutações GraphQL, com realce de sintaxe e autocompletar.Consulte a documentação de GraphQL no Apidog para obter mais informações sobre como trabalhar com APIs GraphQL.
msgpack#
MessagePack (msgpack) é um formato de serialização binária mais compacto e mais rápido que JSON. O Apidog oferece suporte ao envio de dados msgpack, o que é benéfico ao trabalhar com APIs otimizadas para desempenho e transferência de dados reduzida. 