Create A REST API With JSON Server

In the following will learn how to setup JSON Server and publish a sample REST API

Most of the time we will not get the flexible dummy REST API end points to practice or learn to validate the CRUD operations, we have an option to create full fake REST API with zero coding

Installing JSON Server

JSON Server is available as a NPM package, The installation can be done by using the Node.js package manager, since we are going to use NPM packages we required Node.js to be installed before moving further
  • Install Node.js - download the Node.js and install as per your system requirements (Download Node.js here) and confirm the Node.js is installed successfully on your system as per following the steps shown below 

  • Install JSON Server - We will install JSON Server now using the NPM package, run the below in command prompt 
 npm install json-server (or) npm install -g json-server

** by adding -g option we make sure the package is installed globally on our system 


  • JSON File - Now create a JSON file with some name like data.json and save in some file directory, this is a file data which will be exposed as REST API. a sample file given below for reference
          The above JSON structure consists employees object with 2 data set 


  • Running The Server - Let's run the JSON server by running below command on the terminal
    json-server --watch data.json  (or)  json-server data.json
 

By default the server will open in localhost:3000 port, now you can open the URL in Browser or Postman and you will get the following results that comes from our JSON file which we created earlier



 Now the following HTTP endpoints are created automatically by JSON Server and now we can perform CURD operations 

  1. GET - http://localhost:3000/users
  2. GET - http://localhost:3000/users/{{id}}
  3. POST - http://localhost:3000/users
  4. PUT - http://localhost:3000/users/{{id}}
  5. PATCH - http://localhost:3000/users/{{id}}
  6. DELETE - http://localhost:3000/users/{{id}}
  • POST REQUEST - To create a new user we need to perform a POST request along with the request body and the new user record will be added to our data.json
  • GET REQUEST - Now you can check the newly added user is added to the our JSON Server or not by going with the GET endpoint - http://localhost:3000/users/{{id}}

 And now you can perform all other HTTP request with above mentioned endpoints like PUT, PATCH, DELETE


Finally you can check the logs in server terminal, that all actions that we do from postman will be getting recorded 

  • **Important - Do not close the server which we started from terminal until you preformed all actions, if you close the server the endpoints will not work further, and you can start the server again by following the same steps
  • Video Reference - 



Thanks
Saravanan Seenivasan
QA Lead Engineer


YouTube
LinkedIn
GitHub
Stack overflow
Postman








        
Location: Chennai, Tamil Nadu, India

Comments

  1. UnknownOctober 12, 2021 at 10:37 PM

    Good one Saravanan

    ReplyDelete
  2. VASANTHOctober 12, 2021 at 10:49 PM

    Great content. :) go high saravnnan

    ReplyDelete
  3. PriyadarsiniMuthuvelOctober 12, 2021 at 11:04 PM

    It's very useful content

    ReplyDelete
  4. Amit kumarSeptember 13, 2022 at 11:00 AM

    Here all content so useful and helpful for beginner and experience both.This site is so amazing, This sites gives good knowledge of rest-api,This is very helpful for me.

    ReplyDelete
  5. Nishant SaurabhNovember 30, 2022 at 8:35 AM

    Waoo Awesome content posting,Many developers would agree that selenium-with-core-java is difficult and complex
    whereas selenium-with-core-java is simple and so more productive,This site is so amazing.This sites gives good knowledge of selenium-with-core-java.

    ReplyDelete

Post a Comment

Popular posts from this blog

Change The Default Port Number Of JSON-Server

Image
In my previous blog we have seen how to create a REST API with JSON Server, if you missed please have a look at here  Link And whenever we start the JSON Server it is running on http://localhost:3000 , mean its running in your localhost and the port number is 3000 , In this blog we will see how to change the port number from 3000 to another port (xxxx) incase something you are running already on 3000 Please refer here how to setup the JSON Server on your machine -  Link Once we are done with the setup and if you want to start the JSON Server in different port then we have to run this command in terminal to start the JSON Server Usually we use this command to start JSON Server which will run the server on 3000 port json-server data.json Start the JSON Server in different port Instead of running the above command we have additionally pass the port parameter value to start in particular port as per your need json-server -p 4000 data.json And now you can open the  URL ...
Read more
Image
  Shift-Left Development Process   What is shift-left? Shift Left is a practice intended to find and prevent defects early in the software delivery process. The idea is to improve quality by moving tasks to the left as early as the lifecycle. Shift Left testing means testing earlier in the software development process. “Start Testing activities as early as possible in the development life cycle. Test Early and Often” How does it differ from our traditional model? A typical waterfall software development project would have seen testing occur immediately prior to release into production. This meant that when bugs or usability issues were inevitably found, the release would be delayed until these were fixed. Why Shift Left? In the traditional software development model, requirements are kept on the left side of the plan, and the delivery and testing requirements are on the right. The problem is that these practices can’t handle changing expectations and requiremen...
Read more