Documenting endpoints in Express - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to import the Express library.

Express

const express = require('[1]');

Drag options to blanks, or click blank then click option'

Aexpress

Bhttp

Crouter

Dendpoint

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'http' instead of 'express'

Using 'router' which is part of Express but not the main import

The Express library is imported using require('express').

2fill in blank

medium

Complete the code to create a new Express app instance.

Express

const app = [1]();

Drag options to blanks, or click blank then click option'

Aexpress

Brouter

Crequire

Dlisten

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'router()' which is for routing, not app creation

Using 'listen()' which starts the server, not creates the app

You create an Express app by calling express().

3fill in blank

hard

Fix the error in the route definition to respond with 'Hello World'.

Express

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

Drag options to blanks, or click blank then click option'

Ajson

Bwrite

Csend

Drender

Attempts:

3 left

💡 Hint

Common Mistakes

Using res.write which does not end the response

Using res.json which sends JSON, not plain text

The res.send() method sends a response body as plain text.

4fill in blank

hard

Fill both blanks to document the GET endpoint with Swagger.

Express

/**
 * @swagger
 * /users:
 *   [1]:
 *     description: Get all users
 *     responses:
 *       200:
 *         description: Success
 */

Drag options to blanks, or click blank then click option'

Aput

Bget

Cdelete

Dpost

Attempts:

3 left

💡 Hint

Common Mistakes

Using uppercase HTTP methods

Using wrong HTTP verbs like post or put

The Swagger documentation uses lowercase HTTP methods like get to describe endpoints.

5fill in blank

hard

Fill all three blanks to add a Swagger parameter for user ID in the path.

Express

/**
 * @swagger
 * /users/{id}:
 *   get:
 *     parameters:
 *       - in: [1]
 *         name: [2]
 *         required: true
 *         schema:
 *           type: [3]
 */

Drag options to blanks, or click blank then click option'

Apath

Bquery

Cid

Dstring

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'query' instead of 'path' for path parameters

Using wrong parameter name or type

In Swagger, path parameters are declared with in: path, the parameter name, and its type.

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