Tipos de simulação

Tudo nesta documentação roda o mesmo motor de mock; o que muda é onde uma simulação vive e quem faz o deploy dela. São quatro jeitos de rodar uma, e eles não são exclusivos: os times costumam desenvolver contra uma simulação hospedada, rodar uma cópia portable no CI, e manter um serviço codegen para a lógica própria.

Simulações de app

O padrão. Montadas e configuradas inteiras no navegador: você adiciona specs OpenAPI e endpoints estáticos, clica em Fazer deploy, e a simulação responde na URL dela. Tudo que está nas seções Criar, Configurar, Replays e Observar destes docs funciona em uma simulação de app.

Escolha quando quiser um mock hospedado que o time inteiro alcance, sem nada para instalar e com cada mudança feita no app.

Veja Simulações de app.

Simulações do GitHub

A mesma simulação hospedada, mas o repositório é a fonte da verdade: os specs, os endpoints estáticos e a configuração ficam como arquivos, e um push faz o deploy deles pela GitHub Action, com uma URL por branch e por pull request. A Action aceita os dois formatos de projeto: uma pasta portable servida do jeito que está, ou um projeto codegen compilado do código. O app mostra essas simulações em modo leitura; mudar uma é mudar o repo.

Escolha quando os mocks tiverem que ser revisados como código e cada branch precisar do próprio ambiente.

Veja Simulações do GitHub.

Simulações portable

Uma pasta com specs, arquivos estáticos e configuração que o motor serve do jeito que está, onde quer que ele rode: localmente pela CLI, no Docker, dentro do CI, ou hospedada pelo modo portable da GitHub Action. A estrutura é a mesma que as simulações de app empacotam no deploy, então os formatos são intercambiáveis.

Escolha quando o mock tiver que viver como arquivo comum: trabalho offline, pipeline de CI, um repo que o seu time revisa, ou qualquer coisa que não possa sair da sua rede.

Veja Simulações portable.

Simulações codegen

Um servidor Go gerado: o motor transforma o seu spec em handlers tipados que você abre e edita, para as respostas carregarem lógica de verdade, estado e cálculo onde só gerar não basta. O spec nunca sai do seu repositório, o que também livra ele de qualquer limite de upload.

Escolha quando o mock precisar de um comportamento que nenhuma configuração expressa.

Veja Simulações codegen.

E o tipo pronto para usar

Os backends de pagamento e identidade também são simulações, rodando o mesmo motor com o comportamento do provedor já construído: cenários, falhas e dados realistas desde o começo. Eles têm a própria seção.

Veja Backends resilientes.

Como escolher

Escolha o que escolher, o motor é o mesmo: um spec gera as respostas, os endpoints estáticos fixam as exatas, e os contextos dão forma aos dados. Trocar de tipo depois é empacotar os mesmos arquivos de outro jeito, nunca começar de novo.