Visão geral

Os pré-processadores e pós-processadores são uma funcionalidade essencial no Apidog. Quando envia um pedido, pode utilizar pré-processadores para controlar dinamicamente o seu pedido, ou utilizar pós-processadores para tratar a resposta recebida.

O Apidog fornece uma interface visual de arrastar e largar para operações pré e pós-pedido, complementando as abordagens tradicionais baseadas em scripts. Esta interface visual permite-lhe configurar operações comuns sem escrever código, mantendo simultaneamente o suporte para scripts personalizados em casos de utilização avançados.

Início rápido

Seguem-se os passos para utilizar pré-processadores e pós-processadores no Apidog:

Abra qualquer endpoint e navegue até ao separador Run (Modo Design-first) ou ao separador Request (modo Request-first).

Design-first Mode

Request-first Mode

Mude para a secção Pre Processors ou Post Processors, passe o cursor sobre + Add e selecione o processador pretendido.

Preencha os campos necessários para o processador adicionado.

Clique em Send, e o pedido será executado com os pré/pós-processadores configurados.

No Modo Design-first, clique em Save as case para guardar o pedido. No Modo Request-first, clique em Save ou Save as case para guardar o pedido.

Design-first Mode

Request-first Mode

TIP

Também pode criar um pedido autónomo e aplicar-lhe pré/pós-processadores. No entanto, recomendamos que utilize pré/pós-processadores sobre a especificação do endpoint para tornar a depuração e os testes mais simples.

Capacidades

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

Pré-processadores

Configuração de Parâmetros do Pedido: Defina dinamicamente 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 Bases de Dados: Obtenha valores de uma base de dados para utilizar como parâmetros do pedido.

Encriptação: Proteja a carga útil do pedido antes da transmissão.

Pós-processadores

Asserções: Valide a resposta recebida face aos resultados esperados (códigos de estado, conteúdo do corpo, etc.).

Extração de Variáveis: Extraia valores da resposta para utilizar em pedidos subsequentes.

Operações de Base de Dados: Escreva dados da resposta numa base de dados para armazenamento ou atualização.

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

TIP

Determinadas pré-operações e pós-operações podem acionar pedidos de autorização de segurança ao aceder a bases de dados, invocar programas externos ou carregar dinamicamente pacotes npm. Pode navegar até às definições de Security para pré-configurar o âmbito destas autorizações.

Processadores disponíveis

O Apidog suporta os seguintes pré/pós-processadores:

Processador	Tipo	Descrição
Assertion	Pós	Defina regras de validação para verificar dados da resposta face aos valores esperados (código de estado, corpo, cabeçalhos).
Extract Variable	Pós	Extraia valores da resposta (JSON, XML, Texto) e armazene-os como variáveis utilizando JSONPath ou XPath.
Database Operation	Pré/Pós	Ligue-se a bases de dados SQL/NoSQL para executar consultas. Os resultados podem ser armazenados como variáveis.
Custom Scripts	Pré/Pós	Escreva código JavaScript personalizado para tratar lógica complexa. Aceda a dados de pedido/resposta e a variáveis de ambiente.
Public Scripts	Pré/Pós	Crie excertos de scripts reutilizáveis partilhados entre vários processadores ou cenários.
Wait	Pré/Pós	Introduza um atraso antes ou depois de um pedido, útil para simular latência do mundo real.

Recomendamos a utilização do Apidog Script Generator para simplificar a escrita de scripts. Descreva a sua lógica em linguagem natural, e o gerador criará um script executável para si.

Ordem de execução

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

Nível de Execução/Caso do Endpoint (Predefiniçã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: Afeta todos os endpoints dentro da pasta.

Nível do Projeto: Aplica-se a todos os pedidos dentro do projeto (âmbito mais elevado).

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

Visualizar a execução

Um conjunto de pré-processadores num pedido pode ter o seguinte aspeto:

Na captura de ecrã acima:

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

Estes processadores herdados são só de 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

Poderá notar um passo chamado Variable Substitution & Inherit from Parents. Este pré-processador especial substitui marcadores de posição como {{variable}} pelos respetivos valores reais.

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

Pós-substituição: Alguns scripts (por exemplo, assinatura de API) têm de ser executados depois de as variáveis serem substituídas. Pode arrastar manualmente estes processadores para baixo do passo "Variable Substitution".

Fluxo de execução completo

A ordem de execução detalhada para um único pedido é a seguinte:

Início rápido#

Capacidades#

Pré-processadores#

Pós-processadores#

Processadores disponíveis#

Ordem de execução#

Visualizar a execução#

Substituição de variáveis#

Fluxo de execução completo#

Início rápido

Capacidades

Pré-processadores

Pós-processadores

Processadores disponíveis

Ordem de execução

Visualizar a execução

Substituição de variáveis

Fluxo de execução completo