O cliente Apidog oferece suporte ao envio de requisições de API com HTTP, GraphQL, SOAP, gRPC e outros protocolos populares. Você pode criar requisições no Apidog, enviá-las para observar as respostas e salvá-las para colaboração em equipe.Criar uma Nova Requisição#
Para criar uma requisição no Apidog, você só precisa clicar em "+" → "Nova Requisição".Você pode preencher as partes necessárias da requisição de acordo com a especificação da API na interface do Apidog, como o método da requisição, URL, parâmetros da requisição, autorização e assim por diante.Usando este método, você pode criar requisições HTTP, GraphQL e SOAP. Saiba mais sobre a criação de requisições WebSocket e gRPC na documentação do respectivo protocolo.URL da Requisição#
Para fazer uma requisição no Apidog, você precisa especificar a URL que representa o endpoint da API ao qual você está se conectando. Cada operação que você pode executar usando uma API normalmente está associada a um endpoint, que tem uma URL específica.Se você estiver criando uma API: A URL geralmente consistirá no local base mais um caminho. Por exemplo, na URL da requisição https://api.example.com/user/12, https://api.example.com é a URL base, e /user/12 é o caminho do endpoint.
Se você estiver usando uma API pública: Seu provedor de API fornecerá as URLs necessárias na documentação para desenvolvedores.
O Apidog adicionará automaticamente http:// ao início da sua URL se você não especificar um protocolo.
Métodos de Requisição#
No Apidog, você pode selecionar qual método de requisição usar no lado esquerdo da URL da requisição. O método padrão é GET.Métodos HTTP Comuns#
| Método | Finalidade | Efeito nos Dados |
|---|
| GET | Recuperar dados de um recurso especificado | Somente leitura, sem efeitos colaterais |
| POST | Enviar dados a serem processados para um recurso especificado | Cria novos recursos |
| PUT | Atualizar recursos existentes | Substitui o recurso inteiro |
| 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, a mesma URL pode receber requisições com métodos diferentes, representando operações diferentes no mesmo recurso. Por exemplo, GET /user/{id} normalmente recupera as informações do usuário para este id, enquanto PUT /user/{id} atualiza as informações do usuário para este id.Enviar a Requisição#
Depois de especificar o protocolo, o método e a URL da requisição, adicione quaisquer outros detalhes exigidos pela API para a qual você está enviando a requisição:Parâmetros e Corpo: Forneça quaisquer parâmetros, dados de corpo ou cabeçalhos de requisição que precisem ser enviados com a requisição.
Autenticação: Configure qualquer autenticação e autorização necessárias.
Cookies: Você também tem a opção de usar cookies com suas requisições selecionando a aba Cookies.
Você pode visualizar as requisições enviadas em Histórico na barra lateral e enviá-las novamente. Isso é útil para depuração e para comparar respostas ao longo do tempo.
