Mock personalizado

O Apidog fornece funcionalidades poderosas de personalização de mock que lhe dão controlo detalhado sobre as respostas da API. Este documento apresenta duas abordagens para personalizar dados de mock:

Personalização ao nível do campo: controle campos específicos enquanto utiliza mock inteligente para outros

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

Personalização ao nível do campo

Por vezes, precisa de definir valores específicos para determinados campos enquanto permite que o Apidog gere automaticamente o restante. O Apidog oferece métodos flexíveis para controlo ao nível do campo.

Definir valores de campo personalizados

1. Valores fixos

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

Exemplo:

2. Valores dinâmicos com Faker.js

Gere dados aleatórios realistas utilizando os valores dinâmicos do Apidog (baseados em Faker.js). Utilize 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 a partir do menu pendente:

3. Métodos Faker parametrizados

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

Exemplos:

Caso de utilização	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 matriz	`{{$helpers.arrayElement(['red','blue','green'])}}`	Cor aleatória da matriz
Intervalo de datas	`{{$date.between(from='2024-01-01',to='2024-12-31',format='yyyy-MM-dd')}}`	Data dentro do intervalo especificado

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

4. Concatenar várias expressões

Combine texto estático e várias expressões dinâmicas para gerar valores de campo complexos.

Exemplo: geração de morada completa

{{$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 moradas únicas e realistas para cada chamada de API mock.

Idiomas do mock

O Apidog suporta idiomas de mock personalizáveis, permitindo-lhe gerar dados de teste dinâmicos em diferentes línguas e formatos que correspondam à sua região ou público-alvo. Para saber mais sobre como configurar idiomas de mock, visite Idioma do mock (Locales).

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

Para controlo completo sobre as respostas de mock, utilize expectativas de mock. Esta funcionalidade permite-lhe definir respostas fixas, condicionais ou dinâmicas.

Criar expectativas de mock

Respostas fixas

Devolva os mesmos dados para cada pedido ao criar uma expectativa incondicional.

Passos:

Clique em Nova expectativa

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

Preencha os dados de resposta que pretende devolver e, em seguida, guarde

Copie e utilize o URL de mock fornecido para aceder a este endpoint

Respostas condicionais

Devolva diferentes dados de mock com base nos parâmetros do pedido. O motor de mock avalia as condições de cima para baixo, devolvendo a primeira expectativa correspondente.

Tipos de condição suportados:

Tipo de parâmetro	Descrição
Parâmetros de consulta	Cadeias de consulta do URL
Parâmetros de caminho	Segmentos dinâmicos do URL
Parâmetros de cabeçalho	Cabeçalhos HTTP
Parâmetros de cookie	Valores de cookie
Parâmetros de corpo	Campos do corpo JSON (através de JSON path)

Comportamento das condições

Várias condições são combinadas com lógica AND (todas devem corresponder)

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

Limitações

Os parâmetros de corpo suportam apenas JSON, não XML

As condições de parâmetros não podem utilizar {{variables}}

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

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

Dados de mock dinâmicos

As expectativas de mock suportam dados dinâmicos e aleatórios utilizando a sintaxe de modelos Faker.js e Nunjucks.

Exemplo:

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

Isto gera:

Matriz de 20 objetos de utilizador (id de 0 a 19)

Cada um com nome próprio e apelido gerados aleatoriamente

Um campo constante "success": true

Notas de sintaxe:

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

Diferenças importantes

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

As 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

Funcionalidades avançadas

Cabeçalhos de resposta personalizados

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

Propriedades de resposta avançadas

Configure propriedades de resposta adicionais no separador Mais:

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

Ativar/desativar expectativas

Ative ou desative expectativas de forma independente para ambientes de mock locais e na cloud a partir da lista de expectativas.

Resumo

As funcionalidades de mock personalizado do Apidog fornecem:

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

Controlo completo da resposta através de expectativas de mock

Lógica condicional para respostas baseadas em parâmetros

Geração de dados dinâmicos utilizando Faker.js e Nunjucks

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

Estas funcionalidades permitem-lhe criar simulações de API robustas e de alta fidelidade que refletem com precisão o comportamento em produção!

Personalização ao nível do campo#

Definir valores de campo personalizados#

1. Valores fixos#

2. Valores dinâmicos com Faker.js#

3. Métodos Faker parametrizados#

4. Concatenar várias expressões#

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

Criar expectativas de mock#

Respostas fixas#

Respostas condicionais#

Dados de mock dinâmicos#

Funcionalidades avançadas#

Cabeçalhos de resposta personalizados#

Propriedades de resposta avançadas#

Ativar/desativar expectativas#

Resumo#

Personalização ao nível do campo

Definir valores de campo personalizados

1. Valores fixos

2. Valores dinâmicos com Faker.js

3. Métodos Faker parametrizados

4. Concatenar várias expressões

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

Criar expectativas de mock

Respostas fixas

Respostas condicionais

Dados de mock dinâmicos

Funcionalidades avançadas

Cabeçalhos de resposta personalizados

Propriedades de resposta avançadas

Ativar/desativar expectativas

Resumo