Skip to content

dotronglong/faker

Repository files navigation

Faker - Simple Fake API Server

Run tests on PRs

Installation

bash -c "$(curl -sSL https://raw.githubusercontent.com/dotronglong/faker/master/install.sh)"

Getting Started

Create a folder mocks and put below content to file mocks/users.json

{
  "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": []
  }
}

Next, run this command to start faker

fakerio -s ./mocks

It will parse source folder and start an application on port 3030

Use curl to test the result

curl http://localhost:3030/v1/users
[
  {
    "id": 105,
    "name": "Jesse Ortega",
    "created_at": 1581691318567,
    "updated_at": 1581691318567
  },
  {
    "id": 561,
    "name": "Steven Peterson",
    "created_at": 1581691318567,
    "updated_at": 1581691318567
  },
  {
    "id": 779,
    "name": "John Adams",
    "created_at": 1581691318567,
    "updated_at": 1581691318567
  },
  {
    "id": 768,
    "name": "Joseph Watson",
    "created_at": 1581691318567,
    "updated_at": 1581691318567
  },
  {
    "id": 196,
    "name": "David Howell",
    "created_at": 1581691318567,
    "updated_at": 1581691318567
  }
]

Links