yeehanchung / local-mock-api

For faster local testing and prototyping

Simple API for testing

• Able to GET, POST, PUT, PATCH, DELETE, OPTIONS.
• Changes are persisted between calls.

Getting started

1. Clone this repository on terminal git clone <url>.
2. Open cloned directory simple-api-for-testing.
3. If you haven't installed json-server, type npm i json-server on terminal to install.
4. After installation, start JSON Server locally by typing json-server --watch db.json on terminal.
5. Server is started locally on http://localhost:3000.

🚨 Issue

1. Missing write access to .../node_modules?

Run this command: sudo chown -R $USER /usr/local/lib/node_modules

• sudo means running the command as the system super user, root user.
• chown changes the owner of the file or folder.
• -R changes the owner, so that we can get root access to all files inside the node_modules folder.
• $USER is an environment variable, and by default it is your system username.
• Finally, you can npm install -g json-server.

db.json

{
  "player": [
    {
      "id": 1,
      "name": "John Doe",
      "hobbies": [
        "Cycling",
        "Netlix",
        "Travelling"
      ],
      "addresses": [
        {
          "addressId": "1",
          "postalCode": "7400",
          "country": "Malaysia",
          "state": "Kuala Lumpur",
          "line1": "Jane Street, 191"
        }
      ]
    },
    {
      "id": 2,
      "name": "Marry Lane",
      "hobbies": [
        "Rock climbing",
        "Eating"
      ],
      "addresses": [
        {
          "addressId": "1",
          "postalCode": "2100",
          "country": "Malaysia",
          "state": "Selangor",
          "line1": "Elementi, 200"
        }
      ]
    }
  ]
}

References

1. JSON Server from npmjs.
2. How to fix the "Missing write access" error when using npm.
3. RESTful API Design - PUT vs PATCH.