Serving Your Personal Tutor with a RESTful API Using Express.js

Serving Your Personal Tutor with a RESTful API Using Express.js | CodeSignal Learn

Serving Your Personal Tutor with a RESTful API Using Express.js

Welcome to the next step in our journey of building a personal tutor service! In the previous lesson, we focused on the TutorController, which manages tutoring sessions and handles student queries by interacting with both the model and service layers. Now, we will take a significant step forward by creating a RESTful API for our personal tutor service using Express.js, a popular web framework for Node.js. We'll start by setting up the main Express application, then adapt the TutorController to integrate with session management and HTTP request handling in JavaScript.

Understanding RESTful APIs and Express.js

RESTful APIs are a way for different software systems to communicate over the internet. They provide a set of rules that allow programs to exchange data using standard HTTP methods like GET, POST, PUT, and DELETE . In the JavaScript ecosystem, Express.js is a widely used, minimal, and flexible web framework for building APIs and web applications with Node.js. To get started with Express.js, you can install it using npm by running the following command in your terminal: Shell npm install express npm install express For session management, static file serving, and template rendering, we'll also need a few additional packages: Shell npm install express-session ejs npm install express-session ejs express-session provides session management for Express. ejs is a simple and popular template engine for rendering HTML pages. Now, let's see how to set up our Express application and connect the components we've already built, allowing students to interact with our personal tutor service through a web interface.

Initializing an Express.js App

First, we need to initialize the Express application: JavaScript import express from 'express'; const app = express(); // Set the port for the server const PORT = 3000; // Enable JSON and URL-encoded body parsing app.use(express.json()); app.use(express.urlencoded({ extended: true })); import express from 'express'; const app = express(); // Set the port for the server const PORT = 3000; // Enable JSON and URL-encoded body parsing app.use(express.json()); app.use(express.urlencoded({ extended: true })); Here, we import the Express module and create an application instance with express() . We also set up middleware to parse JSON and URL-encoded request bodies, which is necessary for handling incoming data from clients.

Adding Session Management with express-session

Join the 1M+ learners on CodeSignal

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

Express does not have built-in session management, but the express-session package provides this functionality. Sessions allow us to store data for individual users between HTTP requests, such as a unique student ID. JavaScriptimport session from 'express-session'; app.use(session({ secret: 'your_secret_key_here', // Replace with a strong secret in production resave: false, saveUninitialized: true, cookie: { secure: false } // Set to true if using HTTPS }));import session from 'express-session'; app.use(session({ secret: 'your_secret_key_here', // Replace with a strong secret in production resave: false, saveUninitialized: true, cookie: { secure: false } // Set to true if using HTTPS })); The secret is used to sign the session ID cookie, ensuring session data cannot be tampered with. The cookie options can be adjusted for security as needed.

Creating the Controller Instance

Next, we create an instance of our TutorController to handle the core operations of our personal tutor service: JavaScript import TutorController from './controllers/TutorController.js'; // Create an instance of TutorController to handle tutoring operations const tutorController = new TutorController(); import TutorController from './controllers/TutorController.js'; // Create an instance of TutorController to handle tutoring operations const tutorController = new TutorController(); This controller will manage tutoring sessions and process student queries, serving as the bridge between our API endpoints and the underlying service layer.

Defining and Validating Request Bodies

Unlike some frameworks, Express does not provide built-in request validation. For this lesson, we'll use simple custom validation logic to ensure incoming requests have the required fields. (You can use libraries like express-validator or joi for more advanced validation in the future.) For example, to validate a query request: JavaScriptfunction validateQueryRequest(req, res, next) { const { session_id, query } = req.body; if (!session_id || !query) { return res.status(400).json({ status: 'error', error: { message: 'Missing session_id or query', code: 400 } }); } next(); }function validateQueryRequest(req, res, next) { const { session_id, query } = req.body; if (!session_id || !query) { return res.status(400).json({ status: 'error', error: { message: 'Missing session_id or query', code: 400 } }); } next(); } This middleware checks that both session_id and query are present in the request body before proceeding.

Managing Student Sessions

To ensure each student has a unique identifier, we can use session middleware to check for a student ID in the session and create one if it doesn't exist: JavaScriptimport { v4 as uuidv4 } from 'uuid'; function getStudentId(req, res, next) { if (!req.session.student_id) { req.session.student_id = uuidv4(); } req.student_id = req.session.student_id; next(); }import { v4 as uuidv4 } from 'uuid'; function getStudentId(req, res, next) { if (!req.session.student_id) { req.session.student_id = uuidv4(); } req.student_id = req.session.student_id; next(); } This middleware ensures that every user interacting with the API has a unique student_id stored in their session.

Creating the Index Route

Now that we've initialized our Express application and created our controller instance, let's create the API endpoints that will allow students to interact with our personal tutor service. In Express, routes are defined using methods like app.get() and app.post(). JavaScriptapp.get('/', getStudentId, (req, res) => { res.render('tutor', { student_id: req.student_id }); });app.get('/', getStudentId, (req, res) => { res.render('tutor', { student_id: req.student_id }); }); This route handles GET requests to the root path (/). It ensures the student has a unique ID and renders the tutor.ejs template, passing the student_id to the template.

Creating New Tutoring Sessions

Next, let's define a route for creating new tutoring sessions: JavaScriptapp.post('/api/create_session', getStudentId, (req, res, next) => { const response = tutorController.createSession(req.student_id); if (response.status === 'error') { // Pass error to error handler return next({ status: response.error.code, message: response.error.message }); } res.json(response.data); });app.post('/api/create_session', getStudentId, (req, res, next) => { const response = tutorController.createSession(req.student_id); if (response.status === 'error') { // Pass error to error handler return next({ status: response.error.code, message: response.error.message }); } res.json(response.data); }); This route handles POST requests to /api/create_session. It uses the getStudentId middleware to identify the student, then calls the controller's createSession method. If an error occurs, it passes the error to the error handler; otherwise, it returns the session data.

Handling Student Queries

Now, let's create a route for sending queries to the tutor: JavaScriptapp.post('/api/send_query', getStudentId, validateQueryRequest, (req, res, next) => { const { session_id, query } = req.body; const response = tutorController.sendQuery(req.student_id, session_id, query); if (response.status === 'error') { // Pass error to error handler return next({ status: response.error.code, message: response.error.message }); } res.json(response.data); });app.post('/api/send_query', getStudentId, validateQueryRequest, (req, res, next) => { const { session_id, query } = req.body; const response = tutorController.sendQuery(req.student_id, session_id, query); if (response.status === 'error') { // Pass error to error handler return next({ status: response.error.code, message: response.error.message }); } res.json(response.data); }); This route handles POST requests to /api/send_query. It validates the request body, ensures the student has a unique ID, and processes the query using the controller.

Custom Exception Handling

To ensure consistent error responses across our API, we can add a custom error-handling middleware in Express: JavaScript app.use((err, req, res, next) => {const status = err.status || 500; res.status(status).json({status: 'error', error: {message: err.message || 'Internal Server Error', code: status}});}); app.use((err, req, res, next) => {const status = err.status || 500; res.status(status).json({status: 'error', error: {message: err.message || 'Internal Server Error', code: status}});}); This middleware catches errors passed to next() and returns a JSON response with a consistent structure.

Running the Express.js Server

Now that we've defined our routes and prepared our controller for integration with Express, the final step is to start the server: JavaScript app.listen(PORT, () => {console.log(`Server is running on http://localhost:${PORT}`);}); app.listen(PORT, () => {console.log(`Server is running on http://localhost:${PORT}`);}); This code starts the Express server on the specified port and logs a message to the console when the server is ready.

Adapting the TutorController

The TutorController has been designed to work seamlessly with Express.js, handling student IDs and session management effectively. Let's examine its key methods and how they integrate with our API. JavaScriptimport TutorService from '../services/TutorService.js'; class TutorController { constructor() { this.tutorService = new TutorService(); } createSession(student_id) { if (!student_id) { return this._errorResponse('Session expired', 401); } const session_id = this.tutorService.createSession(student_id); return this._successResponse({ session_id: session_id, message: 'Tutoring session created successfully' }); } sendQuery(student_id, session_id, student_query) { if (!student_id) { return this._errorResponse('Session expired', 401); } if (!session_id || !student_query) { return this._errorResponse('Missing session_id or query', 400); } try { const tutor_response = this.tutorService.processQuery( student_id, session_id, student_query ); return this._successResponse({ message: tutor_response }); } catch (e) { if (e instanceof ValueError) { return this._errorResponse(e.message, 404); } else if (e instanceof RuntimeError) { return this._errorResponse(e.message, 500); } else { return this._errorResponse('Unknown error', 500); } } } _successResponse(data) { return { status: 'success', data: data }; } _errorResponse(message, status_code) { return { status: 'error', error: { message: message, code: status_code } }; } } export default TutorController;import TutorService from '../services/TutorService.js'; class TutorController { constructor() { this.tutorService = new TutorService(); } createSession(student_id) { if (!student_id) { return this._errorResponse('Session expired', 401); } const session_id = this.tutorService.createSession(student_id); return this._successResponse({ session_id: session_id, message: 'Tutoring session created successfully' }); } sendQuery(student_id, session_id, student_query) { if (!student_id) { return this._errorResponse('Session expired', 401); } if (!session_id || !student_query) { return this._errorResponse('Missing session_id or query', 400); } try { const tutor_response = this.tutorService.processQuery( student_id, session_id, student_query ); return this._successResponse({ message: tutor_response }); } catch (e) { if (e instanceof ValueError) { return this._errorResponse(e.message, 404); } else if (e instanceof RuntimeError) { return this._errorResponse(e.message, 500); } else { return this._errorResponse('Unknown error', 500); } } } _successResponse(data) { return { status: 'success', data: data }; } _errorResponse(message, status_code) { return { status: 'error', error: { message: message, code: status_code } }; } } export default TutorController; The controller uses JavaScript class syntax and returns response objects that are easy to handle in Express route handlers. Error handling is performed using standard JavaScript conventions.

Serving Your Personal Tutor with a RESTful API Using Express.js

Understanding RESTful APIs and Express.js

Initializing an Express.js App

Adding Session Management with express-session

Join the 1M+ learners on CodeSignal

Creating the Controller Instance

Defining and Validating Request Bodies

Managing Student Sessions

Creating the Index Route

Creating New Tutoring Sessions

Handling Student Queries

Custom Exception Handling

Running the Express.js Server

Adapting the TutorController

How Students Interact with the Personal Tutor API

Summary and Next Steps