Creating RESTful APIs with Node.js

Photo by Bas van den Eijkhof on Unsplash

Creating RESTful APIs with Node.js

Hey folks! You ever wonder about this? today, we're going to dive into how you can create a restful api using node.js. Honestly, Whether you're building a microservice or just want to back your app with a solid server-side solution, Node.js with its simplicity and scalability makes it a prime candidate. Honestly, Let's get started!

Setting Up Your Project

First things first, you need to set up a new Node.js project.

Assuming you've got Node.js and npm (Node Package Manager) installed, you can create a new folder for your project and initialize it with a package.json file by running:

Source: based on community trends from Reddit and YouTube

Copyable Code Example

mkdir my-rest-api
cd my-rest-api
npm init -y


Next, we need to install Express, which is a fast, unopinionated, minimalist web framework for Node.js. This will handle all the HTTP interfaces we need:

npm install express


Writing Your First API
Now let's write a simple API to get our feet wet. Create a file called app.js. This will be our main server file where we'll set up our endpoints. Add the following code to get started:

const express = require('express');
const app = express();

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000');
});


Here, we've created a basic server that listens on port 3000 and has one route / that responds with "Hello World!" when accessed. To run your server, just type:

node app.js


Open your browser and go to http://localhost:3000. You should see your "Hello World!" message. Congratulations, you've just created your first endpoint!

Expanding Your API
Let's add a few more routes to handle different HTTP methods and endpoints. Update your app.js file to look like this:

const express = require('express');
const app = express();

app.use(express.json()); // Middleware to parse JSON bodies

app.get('/api/users', (req, res) => {
  res.send([
    { id: 1, name: 'John Doe' },
    { id: 2, name: 'Jane Doe' }
  ]);
});

app.post('/api/users', (req, res) => {
  const newUser = req.body; // Assuming JSON input
  res.status(201).send(newUser);
});

app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000/api/users');
});


In this updated version, we have an endpoint to retrieve users with a GET request to /api/users and an endpoint to create a user with a POST request to the same URL. The app.use(express.json()) line tells Express to use middleware that automatically parses JSON formatted request bodies.

There you have it! You’ve expanded your API to handle multiple routes and methods. This is just the beginning, and there's so much more you can do with Node.js and Express.

Keep experimenting, and don't be afraid to dive deeper into the documentation or other resources online. Happy coding!