O cliente Apidog suporta o envio de pedidos de API com HTTP, GraphQL, SOAP, gRPC e outros protocolos populares. Pode criar pedidos no Apidog, enviá-los para observar as respostas e guardá-los para colaboração em equipa.Criar um Novo Pedido#
Para criar um pedido no Apidog, só precisa de clicar em "+" → "Novo Pedido".Pode preencher as partes necessárias do pedido de acordo com a especificação da API na interface do Apidog, tais como o método do pedido, URL, parâmetros do pedido, autorização, entre outros.Com este método, pode criar pedidos HTTP, GraphQL e SOAP. Saiba mais sobre a criação de pedidos WebSocket e gRPC na documentação do respetivo protocolo.URL do Pedido#
Para efetuar um pedido no Apidog, tem de especificar o URL que representa o endpoint da API ao qual se está a ligar. Cada operação que pode executar através de uma API está normalmente associada a um endpoint, que tem um URL específico.Se estiver a criar uma API: O URL será normalmente composto pela localização base mais um caminho. Por exemplo, no URL do pedido https://api.example.com/user/12, https://api.example.com é o URL base e /user/12 é o caminho do endpoint.
Se estiver a utilizar uma API pública: O seu fornecedor de API irá fornecer os URLs de que precisa na respetiva documentação para programadores.
O Apidog irá adicionar automaticamente http:// ao início do seu URL se não especificar um protocolo.
Métodos de Pedido#
No Apidog, pode selecionar o método de pedido a utilizar no lado esquerdo do URL do pedido. O método predefinido é GET.Métodos HTTP Comuns#
| Método | Finalidade | Efeito nos Dados |
|---|
| GET | Obter dados de um recurso especificado | Apenas leitura, sem efeitos secundários |
| POST | Submeter dados para serem processados por um recurso especificado | Cria novos recursos |
| PUT | Atualizar recursos existentes | Substitui o recurso completo |
| PATCH | Aplicar modificações parciais a um recurso | Atualiza campos específicos |
| DELETE | Solicitar a remoção de um recurso | Remove o recurso |
No design de APIs, o mesmo URL pode ser solicitado com métodos diferentes, representando operações diferentes sobre o mesmo recurso. Por exemplo, GET /user/{id} normalmente obtém as informações do utilizador para este id, enquanto PUT /user/{id} atualiza as informações do utilizador para este id.Enviar o Pedido#
Depois de especificar o protocolo, o método e o URL do pedido, adicione quaisquer outros detalhes exigidos pela API para a qual está a enviar o pedido:Parâmetros e Corpo: Forneça quaisquer parâmetros, dados de corpo ou cabeçalhos do pedido que tenham de ser enviados com o pedido.
Autenticação: Configure qualquer autenticação e autorização necessárias.
Cookies: Também tem a opção de utilizar cookies com os seus pedidos selecionando o separador Cookies.
Pode ver os pedidos que enviou em Histórico na barra lateral e enviá-los novamente. Isto é útil para depuração e para comparar respostas ao longo do tempo.
