Automação e testes

Use uma coleção para repetir um conjunto de requisições, uma cadeia quando a resposta fornece valores à chamada seguinte e um agendamento quando uma requisição salva deve executar-se regularmente.

Executar uma coleção

Abra o executor, selecione o ambiente e defina as iterações. Se necessário, acrescente uma pausa entre chamadas. Escolha se uma requisição ou asserção falhada deve interromper a execução. Inicie e acompanhe cada resultado.

Para variar as entradas, escolha um CSV com cabeçalhos ou um array JSON de objetos:

orderId,expectedStatus
1001,200
1002,404

A chamada a {{baseUrl}}/orders/{{orderId}} recebe o orderId da linha. O script posterior lê o status esperado com pm.iterationData.get("expectedStatus"). Cada linha fornece uma iteração.

O resultado inclui status, duração e asserções falhadas. O histórico conserva o nome do arquivo de dados e a quantidade de linhas. Exporte JUnit XML para CI ou HTML para leitura. Reveja o relatório antes de o partilhar, especialmente quando a API devolve dados pessoais ou confidenciais.

Escrever um script focado

O script anterior prepara valores antes da chamada. O posterior verifica a resposta. Coloque este exemplo no editor posterior:

pm.test("Expected status", function () {
    const expected = Number(pm.iterationData.get("expectedStatus") || 200);
    pm.expect(pm.response.code).to.equal(expected);
});

if (pm.response.code === 200) {
    const body = pm.response.json();
    pm.environment.set("orderId", String(body.id));
}

Pode consultar pm.response.text(), pm.response.json(), pm.response.headers.get("Content-Type") e pm.response.responseTime. A API inclui pm.environment, pm.variables, pm.collectionVariables, metadados de pm.request apenas para leitura, pm.iterationData, pm.test, asserções pm.expect ao estilo Chai e console.log.

pm.sendRequest faz uma chamada HTTP adicional com callback, concluído antes de a função retornar. Os scripts executam numa sandbox JavaScript com limite de cinco segundos, sem módulos Node.js nem acesso a .NET. Verifique a compatibilidade dos scripts importados com estas APIs; nem todas as extensões do Postman estão disponíveis. Não há scripts ao nível da coleção nem autenticação editável nesse nível.

Passar valores numa cadeia

Crie a cadeia, acrescente requisições salvas pela ordem pretendida e selecione o ambiente. Uma extração JSONPath, como $.id, coloca o valor da resposta em orderId. A etapa seguinte pode usar {{orderId}}.

As condições verificam existência, igualdade ou presença de texto numa variável, combinando verificações com AND ou OR. Uma condição não satisfeita faz a etapa ser omitida. Ative a interrupção em caso de erro quando as etapas seguintes dependerem do sucesso anterior. Consulte os detalhes para distinguir falhas de etapas omitidas.

Criar um mock no desktop

No editor de mocks, crie uma entrada de servidor e acrescente rotas com protocolo, método ou operação, caminho, resposta e atraso opcional. Modelos, duplicação e verificação de precedência ajudam a preparar as rotas. Também pode salvar uma resposta HTTP do histórico como rota.

As rotas HTTP aceitam respostas exatas ou dados gerados por contrato. Reveja exemplos e cenários e consulte contratos para importar modelos ou fixar uma versão publicada. Os mocks do desktop também aceitam respostas gRPC e sequências WebSocket.

Estes mocks são gratuitos e respondem a chamadas dentro do Echo, sem abrir uma porta de rede. Uma URL HTTP partilhada exige hospedagem pública paga. Para regras na sua aplicação .NET ou snapshots offline, consulte os pacotes.

Agendar uma requisição

Salve a requisição, abra o agendamento e escolha ambiente, expressão cron e modo de execução. Defina o estado ativo e confirme a próxima execução. A expressão */15 * * * *, por exemplo, pede uma execução a cada quinze minutos.

No desktop, o Echo e a máquina precisam de continuar em execução. O modo hospedado continua nos servidores Gapfy com a aplicação fechada e exige plano pago e a permissão correspondente. Aceita HTTP e queries ou mutations GraphQL, com intervalo mínimo de cinco minutos. Não aceita gRPC, WebSocket, SSE nem subscriptions GraphQL.

Aguarde a confirmação de que o agendamento hospedado chegou ao servidor. Uma alteração em fila ou uma sincronização comum não comprova essa entrega. Consulte o último resultado, a mensagem de falha e a duração de referência. Ajuste o limite de regressão ou reponha a referência quando deixar de ser útil. O Maestro apresenta resultados hospedados e resumos sincronizados das execuções de coleções.

Executar no terminal

A CLI gapfy-echo executa pastas no formato Echo sem abrir o desktop. Exige .NET 11 e acesso ao pacote no feed Gapfy. É distinta da ferramenta estável echo-mock do guia de pacotes.

Com a CLI instalada, execute uma exportação de pasta vinculada:

gapfy-echo run collection ./orders --env Development --data ./rows.csv --bail --junit ./results/run.xml --html ./results/run.html

As opções incluem iterações, tempo limite por requisição, proxy e diagnóstico detalhado. Para listar ou obter coleções do servidor, use --server e uma chave de aplicação com RunCollections. As chamadas executam na máquina da CLI, sem envio automático dos resultados.

As cadeias usam arquivos complementares explícitos chains/*.chain.json, run chain e --chain. A exportação de pasta vinculada não cria esses arquivos. OAuth com entrada pelo navegador não está disponível na CLI. Os códigos de saída são 0 para conclusão sem falhas, 1 para falha de requisição ou asserção, 2 para erro de utilização, leitura ou relatório e 130 para cancelamento. Confira a quantidade executada: uma coleção vazia pode terminar sem executar chamadas.

Os assistentes de IA podem preparar asserções, conjuntos de testes e melhorias de cadeias para revisão.