Serving Your Chatbot with a RESTful API Using Express.js

Welcome to the next step in our journey of building a chatbot service with Express.js . In the previous lesson, we focused on the ChatController, which manages chat sessions and handles messages by interacting with both the model and service layers. Now, we will take a significant step forward by creating a RESTful API for our chatbot service using Express.js . We'll start by setting up the main Express.js application, then adapt the ChatController to integrate with Express.js's session management.

Understanding RESTful APIs and Express.js

RESTful APIs are a way for different software systems to talk to each other over the internet. Think of them as a set of rules that allow programs to communicate and share data. Express.js is a lightweight web framework for Node.js that makes it easy to build these APIs. It's like a toolkit that helps you create web applications quickly and efficiently. To get started with Express.js, you can install it using npm by running the following command in your terminal or command prompt: Shellnpm install express Now, we can use it to connect the components we've already built, allowing users to interact with our chatbot service through a web interface. This will enable seamless communication between users and our chatbot service. First, we need to initialize the Express.js application, load environment variables, and set up session management. JavaScriptconst express = require('express'); const session = require('express-session'); const ChatController = require('./controllers/chat_controller'); // Initialize the Express application const app = express(); // Set up session management app.use(session({ secret: 'your_secret_key_here', resave: false, saveUninitialized: true })); // Create an instance of ChatController to handle chat operations const chatController = new ChatController(); Here's a breakdown of the steps involved in this initialization process: Initialize the Express Application: We start by importing the necessary modules, including Express itself. The express() function is then called to create our application object, app. This object will be used to configure and run our web application. Set Up Session Management: Setting up session management is crucial for maintaining user sessions in Express.js. We use the express-session middleware to handle session data. The secret key is used to sign the session ID cookie, ensuring that the data stored in the session is secure and cannot be tampered with by clients. You should use a strong, random value for the secret key to enhance security. Create an Instance of the Controller: Finally, we create an instance of our ChatController. This controller will handle the core operations of our chatbot service, such as managing chat sessions and processing messages.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Defining Routes for the Chatbot Service

Next, we define the routes for our chatbot service. These routes will handle requests for creating a new chat session and sending messages.

JavaScript

// Define a route for the index page that ensures a user session
app.get('/', (req, res) => {
  chatController.ensureUserSession(req);
  res.send("Welcome to the Chatbot Service!");
});

// Define a route for creating a new chat session
app.post('/api/create_chat', (req, res) => {
  // Delegate the creation of a chat session to the chat controller
  chatController.createChat(req, res);
});

// Define a route for sending a message in an existing chat session
app.post('/api/send_message', (req, res) => {
  // Delegate the handling of a message to the chat controller
  chatController.sendMessage(req, res);
});

// Define a route for the index page that ensures a user session
app.get('/', (req, res) => {
  chatController.ensureUserSession(req);
  res.send("Welcome to the Chatbot Service!");
});

// Define a route for creating a new chat session
app.post('/api/create_chat', (req, res) => {
  // Delegate the creation of a chat session to the chat controller
  chatController.createChat(req, res);
});

// Define a route for sending a message in an existing chat session
app.post('/api/send_message', (req, res) => {
  // Delegate the handling of a message to the chat controller
  chatController.sendMessage(req, res);
});

Here's how each route functions within our chatbot service:

Index Route (/): This route acts as the entry point to our chatbot service. When a user accesses this route, it ensures that a user session is established by invoking the ensureUserSession method of the ChatController. After setting up the session, it returns a welcome message to the user, indicating that the service is ready for interaction.
Create Chat Route (/api/create_chat): This route is designed to initiate a new chat session. It listens for POST requests and delegates the task of creating a chat session to the ChatController by calling its createChat method. The controller handles the session creation and returns a response, which is then sent back to the client.
Send Message Route (/api/send_message): This route facilitates sending messages within an existing chat session. It also listens for POST requests and delegates the message processing to the ChatController by invoking its sendMessage method. The controller processes the message and returns the AI's response, which is then delivered to the client.

ChatController: Sending a Message

The sendMessage method is updated to handle requests using Express.js's request and response objects. We now extract chat_id and user_message from the incoming request using the req.body object.

JavaScript

sendMessage(req, res) {
  // Retrieve the user_id from the session
  const user_id = req.session.user_id;

  // Check if the session has expired (user_id is not present)
  if (!user_id) {
    return res.status(401).json({ error: 'Session expired' });
  }

  // Extract chat_id and user_message from the incoming JSON request
  const { chat_id, message: user_message } = req.body;

  // Check if chat_id or user_message is missing
  if (!chat_id || !user_message) {
    return res.status(400).json({ error: 'Missing chat_id or message' });
  }

  try {
    // Process the message using the ChatService and get the AI's response
    const ai_response = this.chatService.processMessage(user_id, chat_id, user_message);
    // Return the AI's response as a JSON object
    return res.json({ message: ai_response });
  } catch (error) {
    // Handle specific error scenarios and return appropriate JSON responses
    if (error instanceof ValueError) {
      return res.status(404).json({ error: error.message });
    }
    return res.status(500).json({ error: error.message });
  }
}

sendMessage(req, res) {
  // Retrieve the user_id from the session
  const user_id = req.session.user_id;

  // Check if the session has expired (user_id is not present)
  if (!user_id) {
    return res.status(401).json({ error: 'Session expired' });
  }

  // Extract chat_id and user_message from the incoming JSON request
  const { chat_id, message: user_message } = req.body;

  // Check if chat_id or user_message is missing
  if (!chat_id || !user_message) {
    return res.status(400).json({ error: 'Missing chat_id or message' });
  }

  try {
    // Process the message using the ChatService and get the AI's response
    const ai_response = this.chatService.processMessage(user_id, chat_id, user_message);
    // Return the AI's response as a JSON object
    return res.json({ message: ai_response });
  } catch (error) {
    // Handle specific error scenarios and return appropriate JSON responses
    if (error instanceof ValueError) {
      return res.status(404).json({ error: error.message });
    }
    return res.status(500).json({ error: error.message });
  }
}

If any required data is missing, the method returns an error response. The message is processed using the ChatService, and the AI's response is returned as a JSON object. We've also implemented error handling to provide appropriate JSON responses for different scenarios, ensuring that all interactions with the API are consistent and informative.