Criar mock de api utilizando Mockoon.
Algumas vezes é necessário fazer o mock de uma api, ou seja, utilizar de uma api fake. Geralmente isso é utilizado quando o desenvolvimento do front-end foi finalizado porem o desenvolvimento do backend, no caso a api, ainda não. Para poder testar o frontend é possível fazer uso de um mock, simulando assim as respostas de um api. Vamos utilizar o Mockoon para criar algumas requisições de exemplo.
Material baseado no video :https://www.youtube.com/watch?v=tJRN5WBF5Wc
Configurações
Site para realizar o download
Fazer o download e a instalação normal.
Criar novo ambiente.
No ambiente criado clicar na aba Settings e verificar o a porta em que a aplicação vai ser alocada. No caso é a porta 3003 ou seja http://localhost:3003/
Iniciar servidor/reload e desligar.
Adicionar nova rota.
Métodos
Criar método Get — retornando vários clientes
Onde
1 — Método e rota da requisição.
2 — Resposta esperada daquela requisição.
3 — Body que deve ser retornado ao realizar aquela requisição.
Ao realizar essa requisição no postman temos o seguinte resultado:
Onde ao realizar a requisição get para a rota /clientes tanto o status quando o body retornaram de acordo com que foi estabelecido no Mockoon.
Criar método Get — retornando um cliente específico
Esse é mais complexo pois podemos retornar mais de uma resposta, tanto positiva, quanto de cliente não encontrado.
Vamos começar pela mais simples — 404
Onde:
1 — Nossa rota get, aqui colocando o :userid para poder pegar o id que o usuário passar como parâmetro.
2 — Resposta 404 — não contrado, vamos transforma-la em padrão, jaja.
3 — Novamente 404 — Not Found.
Uma coisa que já devemos fazer é marcar esse ícone de bandeira ao lado da resposta 1–404, pois assim o sistema entende que essa é a resposta padrão, para caso a requisição não se encaixe em nenhuma das regras estabelecidas (que iremos fazer logo mais à frente).
Agora a segunda resposta — 200.
Onde :
1 — Continua sendo a rota que vamos utilizar passando o :userid
2 — A parte principal, a regra (ou rule) para que essa resposta seja devolvida.
3 — O body que deve ser retornado, desde que a regra seja atendida.
Agora veremos a regra:
Onde:
1 — Colocamos o que deve ser levado em conta para verificar se está igual. No caso utilizamos um parâmetro da rota, mas poderíamos levar em conta o body, por exemplo.
2 — Parâmetro da rota que deve ser levado em conta, que no caso é userid.
3 — Aqui podemos colocar o tipo de verificação, no caso foi utilizado equals, porem poderia ser null, que é uma das opções disponíveis.
4 — Por último o valor que deve estar no parâmetro userid, no caso 1.
Fazendo essa requisição no postman:
Podemos ver que ao passar o valor 1 ele retorna o cliente com o mesmo id, e com o status 200, como foi cadastrado no mockoon.
Agora vamos fazer uma segunda resposta, para o cliente de id 2.
O que deve mudar nesse caso é o body, retornando as informações do cliente de id 2 e a regra.
A única mudança que precisamos fazer é no ultimo campo, o que identifica o valor que deve conter dentro do userid.
Ao realizar essa requisição no postman:
Podemos ver que ao passar o valor 2 ele retorna o cliente com o mesmo id, e com o status 200.
Caso enviarmos pelo postman um valor que não esteja presente em nenhuma das regras, por exemplo o id 3 o retorno deve ser 404 — not found, que foi a primeira resposta que configuramos.
Criar método Post — Realizar o cadastro de um cliente
1 — Método post e caminho da requisição.
2 — Reposta 1–200
3 — Status 200 — OK
4 — Body — Aqui estamos fazendo uso da biblioteca faker do javascript. Dessa maneira quando a requisição for feita serão gerados dados falsos, porem que façam sentido.
Executando essa requisição no postman:
Criar método Put — atualizar cliente.
1 — Rota para o método put.
2 — Status da resposta.
3 — Body que vai ser retornado, utilizando o urlParam, o sistema vai retornar o mesmo id enviado na url.
Ao realizar essa requisição no Postman:
Criar método Delete — deletar um cliente
Primeiramente vamos criar a resposta padrão, 404 — cliente não encontrado.
1 — Rota para o método delete.
2 — Resposta 404, marcada como padrão.
Resposta 200, com uma regra.
Aqui a regra, que só deve retornar 200 quando o id passado for 2.
Ao executar essa requisição no postman: