Verificador de endpoint de API

Verificações opcionais da resposta

Deixe qualquer campo em branco para ignorar a verificação. Um cabeçalho oculto ou um corpo ilegível indica que não foi possível verificar, não uma falha.

O CORS controla quais respostas e cabeçalhos esta página pode ler. O destino recebe a requisição e seu endereço IP.

Estado
Duração
ms
Bytes
URL final após o redirecionamento:
A prévia parou em 1 MiB. O endpoint pode ter retornado mais dados.

Verificações da resposta

Relatório de uma requisição com dados omitidos

O arquivo inclui o método, o endereço do endpoint reduzido à origem, o status final, o tempo e os resultados das verificações. Omite o caminho e os parâmetros da URL, os cabeçalhos e o corpo da requisição, além do corpo e dos valores dos cabeçalhos da resposta.

Envie uma requisição GET, HEAD, POST, PUT, PATCH ou DELETE do navegador e examine a resposta final. Acrescente verificações opcionais para um código ou intervalo de status, um cabeçalho exposto da resposta e uma propriedade JSON. Cada verificação solicitada retorna Aprovado, Reprovado ou Indisponível. A ferramenta mostra o status final, o tempo até a chegada dos cabeçalhos, os cabeçalhos visíveis ao navegador e até 1 MiB do texto da resposta. A requisição só é enviada quando você seleciona Enviar requisição.

Como verificar um endpoint de API

  1. 1

    Informe a requisição

    Digite uma URL HTTP ou HTTPS e escolha o método. Adicione cabeçalhos ou um corpo caso o endpoint exija. GET e HEAD não enviam o corpo informado.

  2. 2

    Defina as verificações opcionais

    Use um código como 200, um intervalo como 200-204 ou uma família como 2xx. Você também pode informar o nome de um cabeçalho da resposta e um caminho JSON, com um valor esperado opcional para cada um. Deixe um campo em branco para ignorar a verificação.

  3. 3

    Envie e leia o resultado

    Selecione Enviar requisição uma vez. Confira o status final e o resultado de cada verificação. Um cabeçalho oculto, uma resposta ilegível ou um corpo JSON incompleto podem tornar uma verificação Indisponível.

  4. 4

    Salve um relatório com dados omitidos

    Baixe um relatório em texto ou JSON dessa verificação. Ele registra a origem do endpoint, o método, o status final, o tempo e os resultados, mas omite o caminho e os parâmetros da URL, os valores da requisição e o conteúdo da resposta.

Exemplo de verificação da resposta

Suponha que seu endpoint GET https://api.example.com/health retorne o status 200, um cabeçalho exposto Content-Type: application/json e {"status":"ready"}. Você poderia preencher:

Campo opcional Exemplo O que verifica
Códigos de status esperados 200, 204 ou 2xx Se o status final pertence ao conjunto selecionado.
Nome do cabeçalho da resposta Content-Type Se o navegador consegue ver esse cabeçalho.
Valor esperado do cabeçalho application/json Se o valor visível corresponde exatamente ao esperado. Deixe em branco para verificar apenas a visibilidade.
Caminho da propriedade JSON $.status Se a propriedade existe em uma resposta JSON completa.
Valor JSON esperado "ready" Se o valor JSON interpretado corresponde ao esperado. Deixe em branco para verificar apenas a existência.

O campo de valor JSON aceita a sintaxe JSON: use true para um booleano, 42 para um número e "ready" para uma string. Os caminhos começam em $ e aceitam propriedades e índices de arrays, como $.data.items[0].id. Eles não executam scripts nem aceitam filtros. Se a propriedade não existir em um JSON legível, a verificação será reprovada. Um cabeçalho ausente ou oculto pelo CORS fica Indisponível, pois o navegador não consegue distinguir os dois casos.

O que o resultado permite concluir

Resultado Significado
Aprovado A resposta final legível satisfez aquela condição específica.
Reprovado A resposta final legível contrariou a condição, ou a propriedade JSON solicitada não existia.
Indisponível O navegador não pôde determinar o resultado, por exemplo porque não conseguiu ler a resposta, um cabeçalho está ausente ou oculto, ou o corpo JSON está vazio, incompleto ou inválido.

O cronômetro para quando os cabeçalhos da resposta chegam. Ele não mede o download do corpo completo. A requisição expira após 15 segundos; o corpo da requisição é limitado a 1 MiB e a prévia da resposta termina após 1 MiB. Uma prévia truncada não permite verificar uma propriedade JSON. Respostas HEAD e 204 não têm corpo para examinar, portanto a verificação JSON fica Indisponível. A ferramenta segue redirecionamentos e informa a URL final, mas não mostra cada etapa nem repete a requisição automaticamente. O CORS do navegador pode impedir a leitura da resposta mesmo quando o endpoint recebeu a requisição. O navegador também pode enviar uma requisição preliminar CORS antes do método solicitado.

Só é possível examinar os cabeçalhos da resposta expostos ao navegador. Para um cabeçalho personalizado, talvez seja preciso incluí-lo em Access-Control-Expose-Headers no endpoint. Um cabeçalho invisível nesta página pode estar ausente no servidor ou simplesmente oculto pelo CORS. Consulte os logs do servidor ou um cliente de API apropriado para distinguir os casos.

Perguntas frequentes

Reprovado significa que uma resposta legível pelo navegador contrariou o esperado. Indisponível significa que o navegador não conseguiu determinar o resultado. Por exemplo, ele não sabe se um cabeçalho invisível está ausente ou oculto pelo CORS, nem consegue verificar JSON em um corpo vazio, ilegível ou truncado.

Você pode informar um cabeçalho Authorization se o endpoint permitir essa requisição do navegador pelo CORS. O verificador não inclui cookies do navegador nem outras credenciais enviadas automaticamente. O valor do cabeçalho vai diretamente ao destino, então use credenciais apenas com um endpoint de confiança.

O navegador envia a requisição diretamente ao destino, que recebe a requisição e seu endereço IP. A URL, os cabeçalhos e o corpo informados não passam pelos servidores deste site nem aparecem na URL da página da ferramenta. O relatório com dados ocultados mantém a origem do endpoint, mas omite o restante da URL, os cabeçalhos e o corpo da requisição. Para passar de uma etapa a outra, o verificador guarda os dados por pouco tempo no armazenamento de sessão desta aba. O registro é aceito por no máximo cinco minutos e removido quando é lido, quando você recomeça ou após uma verificação. Enquanto existir, scripts deste mesmo site poderão lê-lo. Se o navegador bloquear o armazenamento, você ainda poderá enviar a requisição na mesma página.

Um relatório em texto ou JSON é gerado para a verificação atual. Ele inclui a origem do endpoint, o método, o status final, o tempo até os cabeçalhos da resposta, a quantidade de bytes capturados, os indicadores de redirecionamento e truncamento e os resultados das verificações. Exclui o caminho, os parâmetros e o fragmento da URL, os cabeçalhos da requisição e seus valores, o corpo da requisição, os cabeçalhos da resposta e seus valores e o corpo da resposta. Revise o arquivo antes de compartilhá-lo, pois a origem e os resultados ainda podem identificar seu serviço.

O cronômetro começa logo antes de o navegador iniciar o Fetch e para quando chegam os cabeçalhos da resposta final. Inclui o tempo gasto pelo navegador e pela rede, além dos redirecionamentos permitidos, mas não a leitura do corpo. Os logs do servidor podem medir outro intervalo.

Não. A verificação é executada quando você seleciona Enviar requisição. A ferramenta não agenda, repete automaticamente nem monitora requisições. As requisições preliminares CORS e os redirecionamentos seguidos pelo navegador ainda podem gerar mais de uma requisição de rede para uma verificação.

Ferramentas relacionadas

Ferramenta disponível em outros idiomas