API Mock
O API Mock simula respostas de APIs REST para frontend e BFF. Você define endpoints com JSON fixo e controla cenários com temas e jornadas — sem depender de homolog ou backend real.
Para quem é
- Desenvolvedores frontend que precisam de dados estáveis
- Times de BFF que consomem APIs internas
- QA explorando fluxos com cenários ligados/desligados
Como funciona
App (browser / mobile / BFF)
│
▼
http://127.0.0.1:5000/api/mock/{slug}/{path}
│
▼
Mock Flow Desktop (Express local)
│
├─ JSON base do endpoint
├─ + overrides de temas ativos
└─ + filtros da jornada ativaO servidor roda apenas em localhost (127.0.0.1, porta padrão 5000). Nada sai da sua máquina.
Peças do modelo
| Peça | O que é |
|---|---|
| Projeto | Container da aplicação simulada |
| API | Agrupamento lógico de endpoints |
| Endpoint | Rota mock (GET /cart, POST /orders, …) |
| Tema | Cenário que altera vários endpoints juntos |
| Jornada | Combinação de temas para um fluxo completo |
Resolução da resposta
- Encontra o projeto pelo slug
- Localiza endpoint por método + path
- Começa com o JSON base (
baseResponse) - Se houver jornada ativa → aplica os temas dela
Senão → aplica temas com switch ligado - Para cada override ativo → substitui o JSON
- Retorna status HTTP configurado + corpo
Status HTTP
Cada endpoint tem um statusCode configurável:
- 2xx — retorna o JSON do mock
- 4xx / 5xx — envelope de erro padronizado
- 204 / 304 — sem corpo
Onde configurar no app
Abra um projeto → aba API Mock:
- APIs — grupos de endpoints
- Endpoints — método, path, JSON base, status
- Temas — overrides por endpoint
- Jornadas — combinações de temas
Próximos passos
Last updated on