Mock personalizado

O Apidog fornece recursos avançados de personalização de mock que oferecem controle detalhado sobre as respostas de API. Este documento apresenta duas abordagens para personalizar dados de mock:

Personalização em nível de campo: controle campos específicos enquanto usa mock inteligente para outros

Personalização completa da resposta: defina respostas de mock completas com expectativas (fixas, condicionais ou dinâmicas)

Personalização em nível de campo

Às vezes, você precisa definir valores específicos para determinados campos enquanto permite que o Apidog gere automaticamente o restante. O Apidog oferece métodos flexíveis para controle em nível de campo.

Definindo valores personalizados de campo

1. Valores fixos

Especifique um valor estático no campo de mock da especificação do endpoint. O Apidog sempre retornará esse valor exato para esse campo, enquanto usará mock inteligente para campos não especificados.

Exemplo:

2. Valores dinâmicos com Faker.js

Gere dados aleatórios realistas usando os valores dinâmicos do Apidog (com base no Faker.js). Use a sintaxe:

{{$category.method}}

Exemplos comuns:

Expressão	Resultado de exemplo
`{{$person.fullName}}`	Rachel Wheeler
`{{$internet.email}}`	Arno.Huels33@yahoo.com
`{{$commerce.productName}}`	Elegant Plastic Bike

Selecione valores dinâmicos diretamente no menu suspenso:

3. Métodos Faker parametrizados

Passe parâmetros para métodos de valores dinâmicos para geração de dados especializada usando a sintaxe aprimorada do Faker.js no Apidog.

Exemplos:

Caso de uso	Expressão	Descrição
Intervalo de inteiros	`{{$number.int(min=0,max=10000)}}`	Inteiro aleatório entre 0 e 10.000
Telefone legível	`{{$phone.number(style='human')}}`	Formato de telefone legível por humanos
Múltiplo de N	`{{$number.int(multipleOf=3)}}`	Inteiro divisível por 3
Elemento de array	`{{$helpers.arrayElement(['red','blue','green'])}}`	Cor aleatória do array
Intervalo de datas	`{{$date.between(from='2024-01-01',to='2024-12-31',format='yyyy-MM-dd')}}`	Data entre o intervalo especificado

Explore a lista completa de módulos, métodos e parâmetros na documentação de módulos de valores dinâmicos.

4. Concatenando múltiplas expressões

Combine texto estático e múltiplas expressões dinâmicas para gerar valores de campo complexos.

Exemplo: geração de endereço completo

{{$location.streetAddress}}, {{$location.city}}, {{$location.state}}, {{$location.zipCode}}, {{$location.country}}

Saída de exemplo:

8507 Hudson Alley, Rochester, Wisconsin, 96512, United States

Cada componente é gerado dinamicamente, criando endereços únicos e realistas para cada chamada de API mock.

Localidades de mock

O Apidog oferece suporte a localidades de mock personalizáveis, permitindo que você gere dados de teste dinâmicos em diferentes idiomas e formatos que correspondam à sua região ou ao seu público-alvo. Para saber mais sobre como configurar localidades de mock, visite Idioma do mock (Localidades).

Personalização completa da resposta (expectativas de mock)

Para controle completo sobre respostas de mock, use expectativas de mock. Esse recurso permite que você defina respostas fixas, condicionais ou dinâmicas.

Criando expectativas de mock

Respostas fixas

Retorne os mesmos dados para cada requisição criando uma expectativa incondicional.

Etapas:

Clique em Nova expectativa

Adicione um nome de expectativa e deixe as condições em branco

Preencha os dados de resposta que você deseja retornar e salve

Copie e use a URL de mock fornecida para acessar este endpoint

Respostas condicionais

Retorne dados de mock diferentes com base nos parâmetros da requisição. O mecanismo de mock avalia as condições de cima para baixo, retornando a primeira expectativa correspondente.

Tipos de condição aceitos:

Tipo de parâmetro	Descrição
Parâmetros de query	Strings de consulta da URL
Parâmetros de path	Segmentos dinâmicos da URL
Parâmetros de cabeçalho	Cabeçalhos HTTP
Parâmetros de cookie	Valores de cookie
Parâmetros de corpo	Campos do corpo JSON (via caminho JSON)

Comportamento das condições

Múltiplas condições são combinadas com lógica AND (todas devem corresponder)

Se nenhuma condição corresponder, o Apidog recorre à prioridade do método de mock em Configurações do projeto → Configurações de recursos → Configurações de mock

Limitações

Parâmetros de corpo aceitam somente JSON, não XML

Condições de parâmetro não podem usar {{variables}}

O formato do corpo da requisição deve corresponder à especificação da API (por exemplo, form-data, JSON)

Condições de endereço IP podem restringir respostas a IPs específicos

Dados de mock dinâmicos

Expectativas de mock aceitam dados dinâmicos e aleatórios usando a sintaxe de template do Faker.js e do Nunjucks.

Exemplo:

{
    "data": [
        {% for i in range(0, 20) %}
        {% if i>1 %},{% endif %}
        {
            "id": {{i}},
            "firstname": "{{$person.firstName}}",
            "lastname": "{{$person.lastName}}"
        }
        {% endfor %}
    ],
    "success": true
}

Isso gera:

Array de 20 objetos de usuário (id de 0 a 19)

Cada um com nomes e sobrenomes gerados aleatoriamente

Um campo constante "success": true

Observações de sintaxe:

Sintaxe	Finalidade
`{{$...}}`	Invoca o Faker.js para valores aleatórios
`{% for ... %}`	Estrutura de loop do Nunjucks
`{{i}}`	Variável de loop do Nunjucks (não é uma variável do Apidog)

Diferenças importantes

O Apidog usa {{$person.firstName}} em vez do Faker.js nativo faker.person.firstName()

Variáveis de projeto/ambiente do Apidog ({{variable}}) não estão disponíveis em expectativas de mock

Consulte a documentação do Faker.js e do Nunjucks para a sintaxe completa

Recursos avançados

Cabeçalhos de resposta personalizados

Adicione cabeçalhos personalizados a expectativas de mock para simular autenticação, paginação ou outros comportamentos de API.

Propriedades avançadas da resposta

Configure propriedades adicionais da resposta na guia Mais:

Propriedade	Finalidade	Padrão
Código de status HTTP	Simular erros ou casos especiais	200
Atraso da resposta	Simular latência de rede (milissegundos)	0

Habilitar/desabilitar expectativas

Ative ou desative expectativas de forma independente para ambientes de mock local e em nuvem a partir da lista de expectativas.

Resumo

Os recursos de mock personalizado do Apidog fornecem:

Personalização flexível de campos com valores fixos ou dinâmicos

Controle completo da resposta por meio de expectativas de mock

Lógica condicional para respostas baseadas em parâmetros

Geração dinâmica de dados usando Faker.js e Nunjucks

Simulação avançada com cabeçalhos personalizados, atrasos e códigos de status

Esses recursos permitem que você crie simulações de API robustas e de alta fidelidade que refletem com precisão o comportamento de produção!

Personalização em nível de campo#

Definindo valores personalizados de campo#

1. Valores fixos#

2. Valores dinâmicos com Faker.js#

3. Métodos Faker parametrizados#

4. Concatenando múltiplas expressões#

Personalização completa da resposta (expectativas de mock)#

Criando expectativas de mock#

Respostas fixas#

Respostas condicionais#

Dados de mock dinâmicos#

Recursos avançados#

Cabeçalhos de resposta personalizados#

Propriedades avançadas da resposta#

Habilitar/desabilitar expectativas#

Resumo#

Personalização em nível de campo

Definindo valores personalizados de campo

1. Valores fixos

2. Valores dinâmicos com Faker.js

3. Métodos Faker parametrizados

4. Concatenando múltiplas expressões

Personalização completa da resposta (expectativas de mock)

Criando expectativas de mock

Respostas fixas

Respostas condicionais

Dados de mock dinâmicos

Recursos avançados

Cabeçalhos de resposta personalizados

Propriedades avançadas da resposta

Habilitar/desabilitar expectativas

Resumo