Quickstart: sua primeira simulação
Em poucos minutos você vai ter um mock de API hospedado em uma URL que o seu time inteiro pode chamar. Tudo acontece no navegador; não tem nada para instalar.
Crie a simulação
Entre e abra Simulações. Clique na seta ao lado de Nova simulação e escolha Simulação de exemplo.
O exemplo é o caminho mais rápido: ele já vem com o spec OpenAPI do Petstore e alguns endpoints estáticos, então não tem nada para configurar.
Veja Criar uma simulação para as outras opções: começar em branco, escolher uma API do catálogo ou trazer o seu próprio spec.
Faça o deploy
A simulação abre na visão de Endpoints, listando tudo que ela vai servir, agrupado por serviço.
Clique em Fazer deploy. Depois de alguns segundos a pílula de status vira Ativa e a URL da simulação aparece abaixo do cabeçalho.
Explore no navegador
Toda simulação com deploy feito serve um explorador de API embutido na própria URL. Abra a URL no navegador para ver os serviços e os endpoints; clicar em um endpoint dispara uma requisição e mostra a resposta gerada.
O explorador pode ser desligado, e a simulação inteira pode ficar atrás de credenciais ou de uma faixa de IP permitida.
Veja Controle de acesso.
Chame ela
Copie a URL e peça um dos endpoints. O seu caminho carrega o nome da sua própria organização e da sua simulação:
curl "https://api.mockz.io/app/docs-shots/tidy-valley/petstore/pets?limit=1"A resposta é gerada a partir dos schemas do spec, com valores novos a cada chamada:
{
"nextPageToken": "cvdzxtlsan",
"pets": [
{
"birthDate": "1994-08-09",
"breed": "Labrador",
"id": "6f5c3020-25f7-4617-86af-f2039c82e986",
"name": "Marley",
"ownerEmail": "charley@xbn.com",
"ownerName": "Glen Streich",
"species": "rabbit",
"status": "sold",
"weightKg": 48
}
]
}As requisições também são validadas: um corpo que quebra o spec é recusado do mesmo jeito que a API real recusaria.
Veja o que aconteceu
Abra Histórico na barra lateral da simulação, em Gravações, e escolha o serviço petstore. Cada chamada aparece com o método, o caminho, o status e o tempo. Clique em uma para ver a requisição e a resposta inteiras.
Tire do ar
Quando terminar de experimentar, clique na seta ao lado de Fazer deploy e escolha Tirar do ar. A simulação para de servir e a URL dela apaga; fazer deploy de novo traz tudo de volta intacto.