Categorias

Servidor Mock de API

Gera um mock server temporario com Redis e respostas dinamicas

Ideal para frontend e testes de API. Reutilize o mesmo mockId para atualizar em quente.

Exemplos de resultados

1 Exemplos

Create a runnable mock API session

Generate a temporary mock server in Redis and test endpoints for one hour

{
  "mockId": "abc123...",
  "baseUrl": "http://localhost:3000/mock/abc123/api"
}
Ver parâmetros de entrada
{ "mockDefinitionJson": "{\n \"name\": \"User Service Mock\",\n \"basePath\": \"/api\",\n \"endpoints\": [\n {\n \"method\": \"GET\",\n \"path\": \"/users/:id\",\n \"status\": 200,\n \"responseType\": \"json\",\n \"dynamicResponse\": true,\n \"responseBody\": {\n \"id\": \"{{params.id}}\",\n \"name\": \"Mock User\",\n \"trace\": \"{{query.trace}}\",\n \"requestedAt\": \"{{now}}\"\n }\n }\n ]\n}" }

Fatos principais

Categoria
Development
Tipos de entrada
textarea, text
Tipo de saída
json
Cobertura de amostras
4
API disponível
Yes

Visão geral

O Servidor Mock de API permite criar rapidamente ambientes de teste temporários baseados em Redis, suportando respostas dinâmicas e endpoints personalizados para acelerar o desenvolvimento frontend e a validação de integrações.

Quando usar

  • Quando o backend ainda não está pronto e você precisa prosseguir com o desenvolvimento do frontend.
  • Para realizar testes de integração e validar o comportamento da aplicação com diferentes status HTTP.
  • Quando você precisa simular respostas dinâmicas baseadas em parâmetros de URL, corpo da requisição ou data atual.

Como funciona

  • Defina a estrutura da sua API, incluindo métodos, caminhos e o corpo da resposta, utilizando o formato JSON.
  • O sistema armazena a configuração no Redis, gerando uma URL base exclusiva para o seu mock.
  • Realize requisições HTTP contra a URL gerada para receber as respostas simuladas.
  • Utilize o mesmo Mock ID em execuções futuras para atualizar as definições do servidor instantaneamente.

Casos de uso

Prototipagem rápida de interfaces frontend sem depender de uma API real.
Simulação de cenários de erro (ex: 404, 500) para testar o tratamento de exceções no cliente.
Desenvolvimento colaborativo onde diferentes times precisam de um contrato de API estável para trabalhar em paralelo.

Exemplos

1. Simulação de Serviço de Usuário

Desenvolvedor Frontend
Contexto
O backend está em desenvolvimento e o frontend precisa exibir dados de perfil de usuário.
Problema
Necessidade de uma API que retorne dados dinâmicos baseados no ID do usuário solicitado.
Como usar
Insira a definição do endpoint no campo JSON e execute para obter a URL base.
Configuração de exemplo
{"name": "User Service", "basePath": "/api", "endpoints": [{"method": "GET", "path": "/users/:id", "status": 200, "responseBody": {"id": "{{params.id}}", "name": "Usuário Teste"}}]}
Resultado
Uma URL de mock é gerada, permitindo chamadas GET para /api/users/123 que retornam o JSON configurado.

2. Teste de Fluxo de Autenticação

QA Engineer
Contexto
É necessário validar a lógica de login no frontend antes da integração final com o serviço de autenticação.
Problema
Simular uma resposta de sucesso de login capturando o nome de usuário enviado no corpo da requisição.
Como usar
Configure um endpoint POST com dynamicResponse habilitado para refletir o corpo da requisição.
Configuração de exemplo
{"endpoints": [{"method": "POST", "path": "/login", "status": 200, "responseBody": {"token": "abc-123", "user": "{{body.username}}"}}]}
Resultado
O frontend recebe um token simulado e o nome de usuário enviado, validando o fluxo de autenticação com sucesso.

Testar com amostras

json

Hubs relacionados

FAQ

Por quanto tempo o servidor mock permanece ativo?

O servidor mock é mantido no Redis por um período de 1 hora após a criação ou última atualização.

É possível atualizar o mock sem criar um novo?

Sim, basta fornecer o mesmo Mock ID original no campo correspondente para sobrescrever a configuração existente.

O servidor suporta variáveis dinâmicas na resposta?

Sim, você pode usar placeholders como {{params.id}}, {{body.username}} ou {{now}} para gerar respostas dinâmicas.

Quais métodos HTTP são suportados?

O servidor suporta os métodos padrão como GET, POST, PUT e DELETE, conforme definido no seu JSON de configuração.

Onde os dados do mock são armazenados?

As definições do seu mock são armazenadas temporariamente em uma instância Redis de alta performance.

Documentação da API

Ponto final da solicitação

POST /pt/api/tools/api-mock-server

Parâmetros da solicitação

Nome do parâmetro Tipo Requerido Descrição
mockDefinitionJson textarea Sim -
mockId text Não -

Formato de resposta

{
  "key": {...},
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
Dados JSON: Dados JSON

Documentação de MCP

Adicione este ferramenta à sua configuração de servidor MCP:

{
  "mcpServers": {
    "elysiatools-api-mock-server": {
      "name": "api-mock-server",
      "description": "Gera um mock server temporario com Redis e respostas dinamicas",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=api-mock-server",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Você pode encadear várias ferramentas, ex: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, máx 20 ferramentas.

Se você encontrar algum problema, por favor, entre em contato conosco em [email protected]