Ao trabalhar com APIs, é essencial compreender como enviar vários tipos de dados com os seus pedidos. O Apidog fornece uma interface intuitiva para o ajudar a construir e enviar pedidos de API com diferentes parâmetros e tipos de dados no corpo.Parâmetros#
Os parâmetros permitem-lhe enviar informações adicionais para o servidor. O Apidog suporta dois tipos principais de parâmetros: parâmetros de consulta e parâmetros de caminho.Parâmetros de Consulta#
Os parâmetros de consulta são acrescentados ao final do URL após um ponto de interrogação (?) e são separados por "e" comerciais (&). São utilizados para enviar dados opcionais ou adicionais para o servidor.No Apidog, tem duas formas convenientes de adicionar parâmetros de consulta aos seus pedidos de API:1.
Diretamente no URL: Pode acrescentar parâmetros de consulta diretamente ao final do URL na barra de endereço. Por exemplo:https://api.example.com/users?page=1&limit=10
2.
Utilizando a secção Query Params: O Apidog fornece uma secção dedicada Query Params abaixo do campo de introdução do URL. Aqui, pode adicionar, editar e remover parâmetros de consulta através de uma interface intuitiva. Os parâmetros que adicionar nesta secção serão automaticamente acrescentados ao URL do pedido.
Sinal de Igual nos Parâmetros de Consulta#
Em alguns casos especiais, os parâmetros de consulta podem não aparecer como pares chave-valor. Por exemplo, um URL de pedido pode ser:https://api.example.com/users?available
available pode funcionar 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 não quiser omitir este sinal de igual, pode alterá-lo manualmente para "Adicionar um sinal de igual".Parâmetros de Caminho#
Os parâmetros de caminho fazem parte do próprio caminho do URL e são normalmente utilizados para identificar um recurso específico. São indicados por marcadores de posição no URL, normalmente delimitados por chavetas {}.https://api.example.com/users/{userId}
{param} será substituído pelo valor real. Esta funcionalidade é particularmente útil ao testar APIs RESTful que utilizam identificadores de recursos no URL.Se precisar de utilizar variáveis em parâmetros de caminho, a forma recomendada é utilizar primeiro {param} no URL e, em seguida, utilizar {{variable}} no valor do parâmetro.
Corpo#
O corpo do pedido é utilizado para enviar dados para o servidor como parte de um pedido POST, PUT ou PATCH. O Apidog suporta vários formatos de dados de corpo para acomodar diferentes requisitos de API.Comparação dos Tipos de Corpo#
A tabela seguinte fornece uma comparação rápida dos tipos de corpo disponíveis:| Tipo de Corpo | Content-Type | Caso de Utilização | Suporte para Carregamento de Ficheiros |
|---|
| form-data | multipart/form-data | Submissões de formulários com ficheiros | ✓ Sim |
| x-www-form-urlencoded | application/x-www-form-urlencoded | Submissões simples de formulários | ✗ 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 | Carregamentos de ficheiros, 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 chave-valor, semelhante à submissão de um formulário HTML. Este formato é particularmente útil quando precisa de carregar ficheiros juntamente com outros dados.O corpo do tipo form-data será apresentado como multipart/form-data no pedido. Para cada parâmetro no corpo, pode escolher o respetivo tipo, como string, integer, etc.Enviar JSON em form-data: Se precisar de enviar um JSON em form-data, deve definir o tipo de parâmetro como string e, em seguida, preencher o JSON no campo de string.Enviar ficheiros: Se precisar de enviar um ficheiro no pedido, selecione o tipo como file e, em seguida, clique em "Carregar" para escolher um ficheiro local.O Apidog apenas envia o ficheiro no pedido, mas não guarda o ficheiro na nuvem. Portanto, durante a colaboração em equipa, outras pessoas podem ver este pedido, mas não podem enviar diretamente este ficheiro. Tem de transferir este ficheiro para os seus colegas por outros meios para que possam enviá-lo.
JSON#
JSON é um formato de dados amplamente utilizado para pedidos e respostas de API. Pode conceber o esquema de dados na secção Pedido → Corpo → JSON de um endpoint.Ao conceber um esquema de dados JSON, pode utilizar a funcionalidade 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 predefinido é string. Se precisar de adicionar campos aninhados, altere o tipo de campo para object ou array.Se pretender adicionar comentários em JSON, pode ativar "Suporte para JSON com comentários" em Definições → Definições gerais → Definições de funcionalidades → Definições avançadas. Ao enviar JSON, estes comentários serão automaticamente removidos.
XML#
XML (eXtensible Markup Language) é outro formato de dados comum utilizado em comunicações de API. O Apidog suporta cargas úteis XML, permitindo-lhe enviar dados estruturados em formato XML com os seus pedidos de API.raw#
A opção raw permite-lhe enviar qualquer formato de dados personalizado no corpo do pedido. Isto é útil ao trabalhar com APIs que esperam estruturas ou formatos de dados específicos não abrangidos pelas outras opções.binary#
Os dados binários podem ser enviados através desta opção, que é particularmente útil ao carregar ficheiros ou ao trabalhar com APIs que esperam cargas úteis binárias. O Apidog permite-lhe selecionar e enviar ficheiros binários como parte dos seus pedidos de API.GraphQL#
Para APIs que utilizam GraphQL, o Apidog fornece um editor GraphQL dedicado. Esta funcionalidade permite-lhe construir e enviar consultas e mutações GraphQL, com realce de sintaxe e preenchimento automático.Consulte a documentação do 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 do que JSON. O Apidog suporta o envio de dados msgpack, o que é vantajoso ao trabalhar com APIs otimizadas para desempenho e transferência de dados reduzida. 