Visão geral

Pré e pós-processadores são um recurso essencial no Apidog. Quando você envia uma requisição, pode usar pré-processadores para controlar dinamicamente sua requisição ou usar pós-processadores para tratar a resposta recebida.

O Apidog fornece uma interface visual de arrastar e soltar para operações pré e pós-requisição, complementando abordagens tradicionais baseadas em scripts. Essa interface visual permite que você configure operações comuns sem escrever código, ao mesmo tempo em que ainda oferece suporte a scripts personalizados para casos de uso avançados.

Início rápido

Veja as etapas para usar pré e pós-processadores no Apidog:

Abra qualquer endpoint e navegue até a aba Executar (Modo design-first) ou a aba Requisição (Modo request-first).

Modo design-first

Modo request-first

Alterne para a seção Pré-processadores ou Pós-processadores, passe o cursor sobre + Adicionar e selecione o processador desejado.

Preencha os campos necessários para o processador adicionado.

Clique em Enviar, e a requisição será executada com os pré/pós-processadores configurados.

No Modo design-first, clique em Salvar como caso para salvar a requisição. No Modo request-first, clique em Salvar ou Salvar como caso para salvar a requisição.

Modo design-first

Modo request-first

TIP

Você também pode criar uma requisição independente e aplicar pré/pós-processadores a ela. No entanto, recomendamos aproveitar os pré/pós-processadores sobre a especificação do endpoint para tornar a depuração e os testes mais simplificados.

Recursos

Pré e pós-processadores podem, em conjunto, realizar várias funcionalidades:

Pré-processadores

Configuração de Parâmetros da Requisição: Defina dinamicamente os dados de entrada para o endpoint da API.

Configuração de Cabeçalhos: Especifique cabeçalhos como Content-Type, Accept e Authorization.

Autenticação: Adicione tokens, chaves de API ou credenciais para endpoints protegidos.

Integração com Banco de Dados: Recupere valores de um banco de dados para usar como parâmetros da requisição.

Criptografia: Proteja a carga útil da requisição antes da transmissão.

Pós-processadores

Assertivas: Valide a resposta recebida em relação aos resultados esperados (códigos de status, conteúdo do corpo etc.).

Extração de Variáveis: Extraia valores da resposta para usar em requisições subsequentes.

Operações de Banco de Dados: Grave dados da resposta em um banco de dados para armazenamento ou atualização.

Visualização de Dados: Gere relatórios ou representações visuais dos dados da resposta.

TIP

Certas operações pré e pós-requisição podem acionar solicitações de autorização de segurança ao acessar bancos de dados, invocar programas externos ou carregar dinamicamente pacotes npm. Você pode navegar até as configurações de Segurança para pré-configurar o escopo dessas autorizações.

Processadores disponíveis

O Apidog oferece suporte aos seguintes pré/pós-processadores:

Processador	Tipo	Descrição
Assertiva	Pós	Defina regras de validação para verificar dados da resposta em relação aos valores esperados (código de status, corpo, cabeçalhos).
Extrair Variável	Pós	Extraia valores da resposta (JSON, XML, Texto) e armazene-os como variáveis usando JSONPath ou XPath.
Operação de Banco de Dados	Pré/Pós	Conecte-se a bancos de dados SQL/NoSQL para executar consultas. Os resultados podem ser armazenados como variáveis.
Scripts Personalizados	Pré/Pós	Escreva código JavaScript personalizado para tratar lógicas complexas. Acesse dados de requisição/resposta e variáveis de ambiente.
Scripts Públicos	Pré/Pós	Crie trechos de script reutilizáveis compartilhados entre vários processadores ou cenários.
Aguardar	Pré/Pós	Introduza um atraso antes ou depois de uma requisição, útil para simular latência do mundo real.

Recomendamos usar o Apidog Script Generator para simplificar a escrita de scripts. Descreva sua lógica em linguagem natural, e o gerador criará um script executável para você.

Ordem de execução

Pré e pós-processadores podem ser configurados em vários níveis:

Nível de Execução/Caso do Endpoint (Padrão): Afeta apenas a execução/caso atual.

Nível do Endpoint: Aplica-se a todos os casos associados ao endpoint.

Nível da Pasta: Impacta todos os endpoints dentro da pasta.

Nível do Projeto: Aplica-se a todas as requisições dentro do projeto (maior escopo).

A execução flui do nível mais alto (Projeto/Pasta) até o nível específico de Execução/Caso.

Visualização da execução

Um conjunto de pré-processadores em uma requisição pode se parecer com isto:

Na captura de tela acima:

Os três primeiros processadores estão agrupados em Herdar do pai. Eles são definidos na pasta Root, em pastas específicas (por exemplo, "Pets") ou no próprio endpoint.

Esses processadores herdados são somente leitura na execução atual, mas podem ser ativados/desativados.

O último processador é um script personalizado adicionado especificamente para esta execução e pode ser editado diretamente.

Substituição de variáveis

Você pode notar uma etapa chamada Substituição de Variáveis e Herdar dos Pais. Esse pré-processador especial substitui placeholders como {{variable}} por seus valores reais.

Comportamento padrão: A maioria dos pré-processadores é executada antes da substituição de variáveis.

Pós-substituição: Alguns scripts (por exemplo, assinatura de API) devem ser executados depois que as variáveis forem substituídas. Você pode arrastar manualmente esses processadores para abaixo da etapa "Substituição de Variáveis".

Fluxo de execução completo

A ordem de execução detalhada para uma única requisição é a seguinte:

Início rápido#

Recursos#

Pré-processadores#

Pós-processadores#

Processadores disponíveis#

Ordem de execução#

Visualização da execução#

Substituição de variáveis#

Fluxo de execução completo#