Scripts de Mock

Os scripts de mock permitem que você crie respostas de mock inteligentes com relações lógicas entre parâmetros da requisição e dados da resposta. Esse recurso é essencial quando você precisa de dados de mock que mantenham precisão contextual ou reflitam valores da requisição.

Casos de Uso

Scripts de mock são ideais para cenários que exigem relações lógicas entre dados:

Exemplos Comuns

Retornar na resposta um ID de usuário que corresponda ao ID solicitado (por exemplo, ID da requisição 1001 → a resposta inclui o ID 1001)

Garantir consistência temporal (por exemplo, o horário de término é sempre posterior ao horário de início)

Calcular campos relacionados (por exemplo, preço total com base na quantidade e no preço unitário)

Refletir parâmetros da requisição no payload da resposta

Como os Scripts de Mock Funcionam

Scripts de mock processam dados por meio de um fluxo de trabalho de cinco etapas:

Smart mock ou outros recursos de mock geram uma resposta inicial

O script de mock acessa os objetos $$.mockResponse e $$.mockRequest

A lógica JavaScript recupera e processa dados desses objetos

O método $$.mockResponse.setBody atualiza a resposta com dados modificados

O mecanismo de mock retorna a resposta final processada

Scripts de mock funcionam somente com Smart mock. Eles não se aplicam a expectativas de mock nem a exemplos de resposta.

Usando Scripts de Mock

Habilitando e Escrevendo Scripts

Navegue até a guia Mock, onde a seção Script de Mock aparece na parte inferior

Ative o seletor de script

Escreva seu script no editor e salve

Referência de Script

Exemplo Básico

O que este script faz:

Recupera a resposta de mock inicial gerada automaticamente

Modifica a resposta ao:

Definir page para corresponder ao parâmetro de página solicitado

Definir um valor fixo de total como 120

Atualiza a resposta de mock com essas alterações

Objeto $$.mockRequest

O objeto $$.mockRequest representa a requisição recebida. Ele é semelhante ao objeto pm.request do Postman, com recursos adicionais.

Métodos Principais:

Método/Propriedade	Descrição
`getParam(key)`	Recupera parâmetros de qualquer local (query, corpo etc.)
`headers`	Acessa cabeçalhos HTTP
`cookies`	Acessa valores de cookies
`body`	Acessa o corpo da requisição
`formdata`	Acessa parâmetros form-data
`urlencoded`	Acessa parâmetros codificados em URL

Exemplos de Uso:

Objeto $$.mockResponse

O objeto $$.mockResponse representa a resposta que será enviada de volta. Ele é semelhante ao objeto pm.response do Postman, com métodos de controle adicionais.

Métodos Principais:

Método	Parâmetros	Descrição
`setBody(body)`	any	Define o corpo da resposta
`setCode(code)`	number	Define o código de status HTTP
`setDelay(duration)`	number (ms)	Adiciona atraso à resposta (simula latência)
`json()`	-	Recupera a resposta como JSON
`headers`	-	Acessa/modifica cabeçalhos da resposta

Exemplos de Uso:

Perguntas Frequentes

P: Como usar variáveis do Apidog em scripts de mock?

R: Scripts de mock não podem usar variáveis do Apidog.

Variáveis são um recurso do cliente Apidog, mas o mecanismo de mock é executado de forma independente e não consegue acessar variáveis do lado do cliente.

P: Como usar instruções de log em scripts de mock?

R: Scripts de mock não fornecem funcionalidade de log.

O console é um recurso do lado do cliente, mas o mecanismo de mock opera separadamente e não consegue enviar logs para o console do cliente.

P: Por que não consigo usar o objeto pm em scripts de mock?

R: O objeto pm não está disponível em scripts de mock.

Scripts de mock são executados no servidor de mock, enquanto scripts pre/post são executados no cliente Apidog. Esses são ambientes de execução completamente diferentes, com objetos e sintaxes disponíveis diferentes.

P: Scripts de mock funcionam com expectativas de mock?

R: Não, scripts de mock funcionam somente com Smart mock.

Quando uma expectativa de mock é correspondida, o script de mock não será executado. Scripts de mock não se aplicam a expectativas de mock nem a exemplos de resposta.

Casos de Uso#

Como os Scripts de Mock Funcionam#

Usando Scripts de Mock#

Habilitando e Escrevendo Scripts#

Referência de Script#

Exemplo Básico#

Objeto $$.mockRequest#

Objeto $$.mockResponse#

Perguntas Frequentes#

Casos de Uso

Como os Scripts de Mock Funcionam

Usando Scripts de Mock

Habilitando e Escrevendo Scripts

Referência de Script

Exemplo Básico

Objeto $$.mockRequest

Objeto $$.mockResponse

Perguntas Frequentes