Utilizando o Faker para criar mocks de API REST

O Faker é uma aplicação de código aberto desenvolvida em Java que ajuda a separar o desenvolvimento frontend do backend, eliminando a necessidade de esperar pelo desenvolvimento da API. Este guia apresenta os passos para criar mocks de API REST usando o Faker e Docker.

Procedimentos:

1. Instalação do Docker:

Certifique-se de ter o Docker instalado em seu sistema para facilitar o uso do Faker.

Caso ainda não tenha o Docker instalado na distro Linux com base Debian, então execute no terminal:

$ sudo apt install docker.io docker-compose

2. Configuração do diretório mocks:

Crie um diretório chamado "mocks" em seu sistema. Dentro deste diretório, crie arquivos JSON para definir os mocks de API.

3. Exemplo de arquivo JSON:

Um exemplo de arquivo JSON para um mock de usuários pode ser assim:

{
  "plugins": [
    {
      "name": "list",
      "args": {
        "count": 5,
        "item": {
          "id": "#random:int:min=1&max=1000#",
          "name": "#random:name#",
          "created_at": "#timestamp#",
          "updated_at": "#timestamp#"
        }
      }
    },
    {"name": "random"},
    {"name": "timestamp"}
  ],
  "request": {
    "method": "GET",
    "path": "/v1/users"
  },
  "response": {
    "body": []
  }
}

Este exemplo define um mock para a rota "/v1/users" que retorna uma lista de 5 usuários com campos como "id", "name", "created_at" e "updated_at" gerados aleatoriamente.

4. Execução do container Docker:

Utilize o seguinte comando Docker para executar o Faker:

docker run --rm -p 3030:3030 -v /diretorio/mocks:/app/mocks dotronglong/faker:stable

Este exemplo define um mock para a rota "/v1/users" que retorna uma lista de 5 usuários com campos como "id", "name", "created_at" e "updated_at" gerados aleatoriamente.

Certifique-se de substituir "/diretorio/mocks" pelo caminho absoluto para o diretório de mocks que você criou anteriormente.

5. Acessando os mocks de API:

Após iniciar o container Docker, você pode acessar os mocks de API através do seguinte endpoint:

curl http://localhost:3030/v1/users

OU no browser http://localhost:3030/v1/users

6. Recursos adicionais:

Para mais informações e recursos sobre o Faker, consulte o repositório oficial no GitHub:

https://github.com/dotronglong/faker

7. Adicionar o Faker Mock no arquivo docker-compose.yml

No diretório, onde estão os arquivos JSON com dados de mock, crie o arquivo

docker-compose.yml, conforme abaixo:

version: '3.8'

services:
  mock_faker:
    image: dotronglong/faker:stable
    container_name: mock_faker
    ports:
      - "3030:3030"
    volumes:
      - ".:/app/mocks"
    restart: unless-stopped

Caso, tenha Faker Mock já está em execução, é necessário finalizar, com docker kill

Depois, execute docker-compose up -d

Adicione a URL do Faker Mock com o endpoint definido no arquivo JSON no Postman com o verbo HTTP (GET ou POST).

Feito!