Documenting endpoints in Express

Introduction

Documenting endpoints helps others understand how to use your web server. It explains what each URL does and what data it needs or returns.

When building an API for a mobile app to use your server

When sharing your backend with other developers

When you want to remember what each route does later

When creating public APIs for external users

When testing endpoints with tools like Postman or curl

Syntax

Express

app.METHOD(PATH, HANDLER)

// Example:
app.get('/users', (req, res) => {
  res.send('List of users');
});

METHOD is the HTTP method like get, post, put, delete.

PATH is the URL path for the endpoint.

Examples

This endpoint responds with 'Hello World' when you visit /hello with a GET request.

Express

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

This endpoint handles form submissions sent with POST to /submit.

Express

app.post('/submit', (req, res) => {
  res.send('Form submitted');
});

This endpoint updates a user by their id from the URL.

Express

app.put('/user/:id', (req, res) => {
  res.send(`Update user with id ${req.params.id}`);
});

Sample Program

This Express app has three endpoints. Each one is documented with a comment explaining what it does. This helps anyone reading the code understand the API quickly.

Express

import express from 'express';
const app = express();
const port = 3000;

// Documenting endpoints with comments

// GET / - Welcome message
app.get('/', (req, res) => {
  res.send('Welcome to our API!');
});

// GET /users - Returns a list of users
app.get('/users', (req, res) => {
  res.json([{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }]);
});

// POST /users - Adds a new user (example, no real data handling)
app.post('/users', (req, res) => {
  res.status(201).send('User created');
});

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

Important Notes

Use clear comments above each endpoint to explain its purpose.

Include HTTP method and URL path in your documentation.

Consider using tools like Swagger or Postman for more detailed API docs.

Summary

Documenting endpoints makes your API easier to use and maintain.

Use comments to explain each route's purpose and expected data.

Clear docs help teammates and future you understand your server.

Practice

1. Why is it important to document endpoints in an Express app?

easy

A. To help others understand what each route does and how to use it

B. To make the app run faster

C. To reduce the size of the code

D. To hide the routes from users

Solution

1. Step 1: Understand the purpose of documentation

   Documentation explains the purpose and usage of code parts, making it easier for others to understand.

2. Step 2: Relate documentation to endpoints

   Documenting endpoints clarifies what each route does and what data it expects, helping teammates and future you.

3. Final Answer:

   To help others understand what each route does and how to use it -> Option A

4. Quick Check:

   Documentation improves understanding = B [OK]

Hint: Documentation explains purpose and usage clearly [OK]

Common Mistakes:

• Thinking documentation improves speed
• Confusing documentation with code optimization
• Assuming documentation hides code

2. Which of the following is the correct way to add a comment documenting an Express route?

easy

A. # This route handles user login

B. // This route handles user login

C.

D. /* This route handles user login */

Solution

1. Step 1: Identify comment syntax in JavaScript

   JavaScript uses // for single-line comments and /* */ for multi-line comments.

2. Step 2: Match comment style to Express (Node.js) code

   Express routes are written in JavaScript, so // is correct for single-line comments.

3. Final Answer:

   // This route handles user login -> Option B

4. Quick Check:

   JavaScript single-line comment = // [OK]

Hint: Use // for single-line comments in Express (JavaScript) [OK]

Common Mistakes:

• Using HTML comments in JS code
• Using # which is for Python or shell scripts
• Confusing multi-line comment style for single-line

3. Given this Express route with documentation:

  // Returns user info by ID
  app.get('/user/:id', (req, res) => {
    const id = req.params.id;
    res.send(`User ID is ${id}`);
  });

What will the server respond with when a client requests /user/42?

medium

A. Error: Route not found

B. User ID is :id

C. User ID is 42

D. User ID is undefined

Solution

1. Step 1: Understand route parameter usage

   The route uses :id as a parameter, which is accessed via req.params.id.

2. Step 2: Substitute parameter value from URL

   When requesting /user/42, req.params.id is '42', so the response is 'User ID is 42'.

3. Final Answer:

   User ID is 42 -> Option C

4. Quick Check:

   Route param :id = 42 in response [OK]

Hint: Route params accessed via req.params.name [OK]

Common Mistakes:

• Using literal ':id' instead of param value
• Accessing req.body instead of req.params
• Expecting undefined if param missing

4. This Express route has a documentation comment:

  // Get all products
  app.get('/products', (req, res) => {
    res.send(productsList);
  });

But when running, it throws an error: ReferenceError: productsList is not defined. What is the likely fix?

medium

A. Define the variable productsList before using it in the route

B. Change app.get to app.post

C. Remove the comment to fix the error

D. Rename the route path to /product-list

Solution

1. Step 1: Analyze the error message

   The error says productsList is not defined, meaning the variable is missing or not declared.

2. Step 2: Fix by declaring the variable

   To fix, declare and assign productsList before the route uses it, so the route can send it properly.

3. Final Answer:

   Define the variable productsList before using it in the route -> Option A

4. Quick Check:

   ReferenceError means missing variable = define it [OK]

Hint: Check error message for missing variables [OK]

Common Mistakes:

• Changing HTTP method without reason
• Thinking comments cause runtime errors
• Changing route path unrelated to variable error

5. You want to document an Express POST endpoint that creates a new user. Which of these comments best explains the endpoint clearly and helps future developers?

hard

A. // POST endpoint

B. // This is a route

C. // Handle user data

D. // POST /users - Creates a new user. Expects JSON body with 'name' and 'email'. Returns the created user object.

Solution

1. Step 1: Identify clear and complete documentation

   The best comment explains the HTTP method, route path, expected input, and output clearly.

2. Step 2: Compare options for clarity

   // POST /users - Creates a new user. Expects JSON body with 'name' and 'email'. Returns the created user object. describes method (POST), path (/users), expected data (JSON with 'name' and 'email'), and response (created user object), making it most helpful.

3. Final Answer:

   // POST /users - Creates a new user. Expects JSON body with 'name' and 'email'. Returns the created user object. -> Option D

4. Quick Check:

   Complete, clear docs = // POST /users - Creates a new user. Expects JSON body with 'name' and 'email'. Returns the created user object. [OK]

Hint: Include method, path, input, and output in comments [OK]

Common Mistakes:

• Writing vague or incomplete comments
• Not mentioning expected data format
• Ignoring response details