An API, or Application Programming Interface, is like a waiter in a restaurant. It takes requests from a customer (a client, like a web app) and brings back responses from the kitchen (your server). Building your own API is a fundamental skill for modern web development, and Node.js with Express.js is one of the simplest and most popular ways to get started.

In this guide, we’ll walk through creating a simple REST API for managing a list of books. We'll cover setting up the server, defining routes, and handling basic CRUD (Create, Read, Update, Delete) operations.

Prerequisites

Before you start, make sure you have Node.js and npm (Node Package Manager) installed on your computer. You can download them from the official Node.js website.

Step 1: Set Up Your Project

1. Create a new project directory and navigate into it:

   bash

   mkdir my-book-api
   cd my-book-api

2. Initialize a new Node.js project. This creates a package.json file to manage your dependencies.

   bash

   npm init -y

3. Install Express, the fast and minimalist web framework for Node.js.

   bash

   npm install express

Step 2: Create Your Server File (index.js)

Create a new file named index.js in your project root. This will be the entry point for our application.

Open index.js in your code editor and let's start building our server:

// 1. Import the Express module
const express = require('express');

// 2. Create an Express application
const app = express();

// 3. Define the port our server will run on
const PORT = process.env.PORT || 3000;

// 4. Middleware to parse JSON bodies in requests
// This allows us to access data sent in POST/PUT requests via req.body
app.use(express.json());

// 5. In-memory "database" - a simple array of objects
// This is for demonstration. In a real app, you'd use a real database.
let books = [
  { id: 1, title: 'The Great Gatsby', author: 'F. Scott Fitzgerald' },
  { id: 2, title: 'To Kill a Mockingbird', author: 'Harper Lee' }
];

// 6. Define our API Routes

// GET /books - Fetch all books
app.get('/books', (req, res) => {
  res.json(books); // Send the books array as a JSON response
});

// GET /books/:id - Fetch a single book by its ID
app.get('/books/:id', (req, res) => {
  const book = books.find(b => b.id === parseInt(req.params.id));
  if (!book) {
    return res.status(404).json({ message: 'Book not found' }); // Error handling
  }
  res.json(book);
});

// POST /books - Create a new book
app.post('/books', (req, res) => {
  // Basic validation
  if (!req.body.title || !req.body.author) {
    return res.status(400).json({ message: 'Title and author are required' });
  }

  const newBook = {
    id: books.length + 1, // Simple way to generate an ID
    title: req.body.title,
    author: req.body.author
  };

  books.push(newBook);
  res.status(201).json(newBook); // 201 status means "Created"
});

// PUT /books/:id - Update a book
app.put('/books/:id', (req, res) => {
  const book = books.find(b => b.id === parseInt(req.params.id));
  if (!book) {
    return res.status(404).json({ message: 'Book not found' });
  }

  // Update the book properties if they exist in the request body
  book.title = req.body.title || book.title;
  book.author = req.body.author || book.author;

  res.json(book);
});

// DELETE /books/:id - Delete a book
app.delete('/books/:id', (req, res) => {
  const bookIndex = books.findIndex(b => b.id === parseInt(req.params.id));
  if (bookIndex === -1) {
    return res.status(404).json({ message: 'Book not found' });
  }

  books.splice(bookIndex, 1); // Remove 1 item at the found index
  res.status(204).send(); // 204 status means "No Content" (successful deletion)
});

// 7. Start the server and listen for requests
app.listen(PORT, () => {
  console.log(`Server is running on http://localhost:${PORT}`);
});

Step 3: Test Your API

1. Start your server from the terminal:

   bash

   node index.js

   You should see: Server is running on http://localhost:3000

2. Test your endpoints using a tool like Postman or Thunder Client (VS Code extension).

   Here’s how to test each operation:

   • GET All Books: Send a GET request to http://localhost:3000/books.

   • GET One Book: Send a GET request to http://localhost:3000/books/1.

   • CREATE a Book: Send a POST request to http://localhost:3000/books. In the body, choose "raw" and "JSON", then add:

     json

     {
       "title": "The Hobbit",
       "author": "J.R.R. Tolkien"
     }

   • UPDATE a Book: Send a PUT request to http://localhost:3000/books/3 with a similar JSON body.

   • DELETE a Book: Send a DELETE request to http://localhost:3000/books/3.

Next Steps & Best Practices

This is a great start, but for a real-world application, you would want to:

• Use a real database like PostgreSQL or MongoDB instead of an in-memory array.

• Use environment variables (with the dotenv package) to manage configuration like PORT.

• Implement more robust error handling and input validation (consider using a library like Joi).

• Structure your code into separate files for routes, controllers, and models as it grows.

• Add authentication and authorization to protect your endpoints.

Building APIs is a core skill that unlocks endless possibilities in web development. This simple guide provides the foundation you need to start creating powerful backend services.

As your Node.js applications grow in complexity, maintaining a clean and efficient codebase becomes critical. For developers working within the WordPress ecosystem, this often means leveraging custom plugins and integrations. To ensure your projects are built on a solid and maintainable foundation, explore the expert resources and best practices available at PluginFY.