Working with APIs

Welcome to Day 8 of our Node.js blog series!

Today, we'll explore how to work with APIs in Node.js. APIs (Application Programming Interfaces) allow different software systems to communicate with each other. We'll cover making HTTP requests to external APIs, creating our own RESTful APIs, and handling API responses. By the end of this post, you'll be equipped to both consume and create APIs using Node.js.

What is an API?

An API is a set of rules and protocols for building and interacting with software applications. It defines the methods and data structures that developers can use to interact with the system.

Consuming APIs

To consume an API, you typically make HTTP requests to an API endpoint and handle the response. Node.js provides several modules to perform HTTP requests, such as http, https, and third-party libraries like axios and node-fetch.

Using the http Module:

The built-in http module can be used for making HTTP requests.

 const http = require('http');

 const options = {
   hostname: 'jsonplaceholder.typicode.com',
   port: 80,
   path: '/posts/1',
   method: 'GET'
 };

 const req = http.request(options, (res) => {
   let data = '';

   res.on('data', (chunk) => {
     data += chunk;
   });

   res.on('end', () => {
     console.log(JSON.parse(data));
   });
 });

 req.on('error', (error) => {
   console.error(`Problem with request: ${error.message}`);
 });

 req.end();

Using the https Module:

The https module is similar to http but is used for HTTPS requests.

 const https = require('https');

 https.get('https://jsonplaceholder.typicode.com/posts/1', (res) => {
   let data = '';

   res.on('data', (chunk) => {
     data += chunk;
   });

   res.on('end', () => {
     console.log(JSON.parse(data));
   });
 }).on('error', (error) => {
   console.error(`Problem with request: ${error.message}`);
 });

Using Third-Party Libraries:

Libraries like axios and node-fetch simplify HTTP requests.

Axios Example:

  const axios = require('axios');

  axios.get('https://jsonplaceholder.typicode.com/posts/1')
    .then(response => {
      console.log(response.data);
    })
    .catch(error => {
      console.error(`Problem with request: ${error.message}`);
    });

Node-Fetch Example:

  const fetch = require('node-fetch');

  fetch('https://jsonplaceholder.typicode.com/posts/1')
    .then(response => response.json())
    .then(data => {
      console.log(data);
    })
    .catch(error => {
      console.error(`Problem with request: ${error.message}`);
    });

Creating RESTful APIs

RESTful APIs follow REST (Representational State Transfer) principles, which involve stateless communication and standard HTTP methods (GET, POST, PUT, DELETE).

Setting Up Express:

Express is a popular web framework for Node.js that simplifies API creation.

Installation:
```
  npm install express
```

Basic Express Server:

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

  app.use(express.json());

  app.listen(port, () => {
    console.log(`Server running on http://localhost:${port}`);
  });

Defining Routes:

Define routes to handle different HTTP methods.

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

 app.use(express.json());

 let posts = [
   { id: 1, title: 'Post 1', content: 'Content 1' },
   { id: 2, title: 'Post 2', content: 'Content 2' }
 ];

 // GET - Read all posts
 app.get('/posts', (req, res) => {
   res.json(posts);
 });

 // GET - Read a single post
 app.get('/posts/:id', (req, res) => {
   const post = posts.find(p => p.id === parseInt(req.params.id));
   if (!post) return res.status(404).send('Post not found');
   res.json(post);
 });

 // POST - Create a new post
 app.post('/posts', (req, res) => {
   const newPost = {
     id: posts.length + 1,
     title: req.body.title,
     content: req.body.content
   };
   posts.push(newPost);
   res.status(201).json(newPost);
 });

 // PUT - Update an existing post
 app.put('/posts/:id', (req, res) => {
   const post = posts.find(p => p.id === parseInt(req.params.id));
   if (!post) return res.status(404).send('Post not found');
   post.title = req.body.title;
   post.content = req.body.content;
   res.json(post);
 });

 // DELETE - Delete a post
 app.delete('/posts/:id', (req, res) => {
   const postIndex = posts.findIndex(p => p.id === parseInt(req.params.id));
   if (postIndex === -1) return res.status(404).send('Post not found');
   const deletedPost = posts.splice(postIndex, 1);
   res.json(deletedPost);
 });

 app.listen(port, () => {
   console.log(`Server running on http://localhost:${port}`);
 });

Testing the API:

Use tools like Postman or cURL to test the API endpoints.
- Postman Example:
  - Send a GET request to http://localhost:3000/posts to retrieve all posts.
  - Send a POST request to http://localhost:3000/posts with a JSON body to create a new post.
  - Send a PUT request to http://localhost:3000/posts/1 with a JSON body to update a post.
  - Send a DELETE request to http://localhost:3000/posts/1 to delete a post.

Handling API Responses

Properly handling API responses ensures that your application can react to different outcomes of the API calls.

Response Status Codes:

Use appropriate HTTP status codes to indicate the result of the request.
- 200 OK: The request was successful.
- 201 Created: A new resource was successfully created.
- 400 Bad Request: The request was invalid or cannot be served.
- 404 Not Found: The requested resource could not be found.
- 500 Internal Server Error: A generic error message when the server fails to fulfill a request.
Response Headers:

Set response headers to provide additional information about the response.
```
 res.setHeader('Content-Type', 'application/json');
```

Error Handling:

Implement error handling to manage unexpected errors gracefully.

 app.use((err, req, res, next) => {
   console.error(err.stack);
   res.status(500).send('Something broke!');
 });

Conclusion

Today, we've explored working with APIs in Node.js. We covered how to consume external APIs using different modules and libraries, how to create RESTful APIs using Express, and how to handle API responses effectively. Understanding these concepts is crucial for building robust and scalable web applications.

In the next post, we'll delve into Express.js. Stay tuned for more in-depth Node.js content!

Anuj Kumar Upadhyay's blog