How to create API node.js from Scratch?

Creating an API with Node.js from Scratch

Introduction

Node.js is a popular JavaScript runtime environment that allows developers to build scalable and high-performance server-side applications. In this article, we will guide you through the process of creating a simple API with Node.js from scratch. We will cover the basics of Node.js, including setting up a new project, creating a server, and building a RESTful API.

Setting Up a New Node.js Project

Before we begin, you need to have Node.js installed on your machine. If you haven’t installed it yet, you can download it from the official Node.js website.

Once you have Node.js installed, you can create a new project using the following command:

npm init -y

This will create a new package.json file in your project directory.

Installing Required Dependencies

To create a simple API, we need to install the following dependencies:

• express: a popular Node.js web framework for building RESTful APIs
• body-parser: a middleware that parses the request body
• express-validator: a library for validating user input

You can install these dependencies using the following command:

npm install express body-parser express-validator

Creating a New Node.js Project

Now that we have installed the required dependencies, we can create a new Node.js project using the following command:

mkdir my-api

cd my-api

npm init -y

This will create a new package.json file in your project directory.

Creating a Server

To create a server, we need to create a new file called server.js. This file will contain the code for our server.

server.js

const express = require('express');

const app = express();

const port = 3000;



// Middleware to parse the request body

app.use(express.json());



// Middleware to validate user input

app.use(express.urlencoded({ extended: true }));



// Route for getting all users

app.get('/users', (req, res) => {

  const users = [

    { id: 1, name: 'John Doe' },

    { id: 2, name: 'Jane Doe' },

  ];

  res.json(users);

});



// Route for getting a single user

app.get('/users/:id', (req, res) => {

  const id = req.params.id;

  const user = users.find((user) => user.id === parseInt(id));

  if (!user) {

    res.status(404).json({ message: 'User not found' });

  } else {

    res.json(user);

  }

});



// Route for creating a new user

app.post('/users', (req, res) => {

  const { name } = req.body;

  const user = { id: users.length + 1, name };

  users.push(user);

  res.json(user);

});



// Route for updating a user

app.put('/users/:id', (req, res) => {

  const id = req.params.id;

  const user = users.find((user) => user.id === parseInt(id));

  if (!user) {

    res.status(404).json({ message: 'User not found' });

  } else {

    user.name = req.body.name;

    res.json(user);

  }

});



// Route for deleting a user

app.delete('/users/:id', (req, res) => {

  const id = req.params.id;

  const index = users.findIndex((user) => user.id === parseInt(id));

  if (index === -1) {

    res.status(404).json({ message: 'User not found' });

  } else {

    users.splice(index, 1);

    res.json({ message: 'User deleted successfully' });

  }

});



app.listen(port, () => {

  console.log(`Server started on port ${port}`);

});

This code creates a simple API with the following endpoints:

• GET /users: returns all users
• GET /users/:id: returns a single user by ID
• POST /users: creates a new user
• PUT /users/:id: updates a user by ID
• DELETE /users/:id: deletes a user by ID

Testing the API

To test the API, you can use a tool like curl or a REST client like Postman.

Here are some examples of how to test the API:

• GET /users: returns all users

  curl http://localhost:3000/users

• GET /users/1: returns a single user by ID

  curl http://localhost:3000/users/1

• POST /users: creates a new user

  curl -X POST -H "Content-Type: application/json" -d '{"name": "New User"}' http://localhost:3000/users

• PUT /users/1: updates a user by ID

  curl -X PUT -H "Content-Type: application/json" -d '{"name": "Updated User"}' http://localhost:3000/users/1

• DELETE /users/1: deletes a user by ID

  curl -X DELETE http://localhost:3000/users/1

  Conclusion

In this article, we have created a simple API with Node.js from scratch. We have covered the basics of Node.js, including setting up a new project, creating a server, and building a RESTful API. We have also tested the API using curl and a REST client like Postman.

This is just a basic example of how to create an API with Node.js. In a real-world application, you would likely want to add more features, such as authentication and authorization, error handling, and logging.

Additional Tips and Resources

• Node.js documentation: The official Node.js documentation is a great resource for learning more about the framework.
• Express.js documentation: The Express.js documentation is another great resource for learning more about the framework.
• Node.js community: The Node.js community is very active and helpful. You can find many resources, including tutorials, blogs, and forums, on the official Node.js website.
• API testing: You can use tools like Postman or cURL to test your API.