Fake REST API NodeJS

Get a full fake REST API as soon as possible. Base on NodeJS + JSON Server.

Support more features:

• Register user with username & password or email & password.

• Login with registered users.

• Protect resources using JWT Bearer authentication.

• Upload files.

Preview: https://fake-rest-api-nodejs.herokuapp.com

Getting started

1. Clone this repository

git clone https://github.com/robinhuy/fake-rest-api-nodejs.git

or fork to your account and clone the forked repo

2. Install dependencies

cd fake-rest-api-nodejs
npm install

or if you using yarn

cd fake-rest-api-nodejs
yarn install

3. Run server

• Production mode:

  npm start

  or

  yarn start

• Development mode (auto reload server when editing using nodemon):

  npm run dev

  or

  yarn dev

• The server will run on http://localhost:3000. You can test with public endpoint: http://localhost:3000/products (GET method).

Modify your data

All the data was placed in database.json. Edit it to suit your purpose.

You can use https://mockaroo.com/ to mock data, and publish your code to https://heroku.com/ or similar hosting to get a Public API.

Note:

• To protect resources, decleare resources and protected methods in database.json:

  "protected_resources": {
    "users": ["GET", "POST", "PUT", "PATCH", "DELETE"],
    "products": ["POST", "PUT", "PATCH", "DELETE"]
  }

• To register new user, using endpoint /register, method POST, request type application/json. Body request like users resources:

• To login, using endpoint /login, method POST, request type application/json. Body request like this:

  {
    "username": "admin",
    "password": "admin"
  }

  or

  {
    "email": "[email protected]",
    "password": "admin"
  }

• To renew AccessToken, using endpoint /renew-token, method POST, request type application/json. Body request like this:

  {
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjEsImlhdCI6MTY1NjMyNzE4NiwiZXhwIjoxNjU2MzI4MDg2fQ.-si1n7yHpjQ2LEyYqZT6ClIFJOqLOeVXRhwjzyvEZMo",
  }

• To upload single file, using endpoint /upload-file, method POST, request type form-data, field file. Uploaded file stored in /public/uploads/.

• To upload multiple files, using endpoint /upload-files, method POST, request type form-data, field files. Uploaded files stored in /public/uploads/.

• Change default port, database file, jwt secret or jwt token expires in config.json.

Access & modify API

Please view detailed document in https://github.com/typicode/json-server/blob/master/README.md#table-of-contents

If you want to change logic of authentication or add more feature, please edit file server.js or additional_routes.js.

Default Endpoints

View and modify resources in database.json.

Open Endpoints

Open endpoints require no Authentication.

User

• Login: POST /login

• Register: POST /register

Product

• Get products: GET /products

• Get product by ID: GET /products/:id

Media

• Upload single file: POST /upload-file

• Upload multiple files: POST /upload-files

Private Endpoints (require Authentication)

Private endpoints require a valid Token to be included in the header of the request. A Token can be acquired from the Login view above.

User

• Get users: GET /users

• Get user by ID: GET /users/:id

• Create user: POST /users

• Update user (entire information): PUT /users/:id

• Update user (partial information) PATCH /users/:id

Product

• Create product: POST /products

• Update product (entire information): PUT /products/:id

• Update product (partial information) PATCH /products/:id