API documentation best practices in Express - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to add a description to the API endpoint using Swagger comments.

Express

app.get('/users', /** [1] */ (req, res) => { res.send('User list'); });

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

A@desc

B@route

C@swagger

D@param

Attempts:

3 left

💡 Hint

Common Mistakes

Using @route instead of @desc for description

Using @param when no parameters are described

The @desc tag is used to add a description to the API endpoint in Swagger comments.

2fill in blank

medium

Complete the code to specify the HTTP method in Swagger documentation.

Express

/**
 * [1] GET /users
 * Returns list of users
 */
app.get('/users', (req, res) => { res.send('User list'); });

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

A@method

B@get

C@route

D@desc

Attempts:

3 left

💡 Hint

Common Mistakes

Using @method which is not a standard Swagger tag

Using @desc instead of @route

The @route tag specifies the HTTP method and path in Swagger documentation.

3fill in blank

hard

Fix the error in the Swagger comment to correctly document a query parameter.

Express

/**
 * @route GET /search
 * @desc Search users
 * @param [1] query.string.required - search term
 */
app.get('/search', (req, res) => { res.send('Search results'); });

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

AsearchTerm

Bterm

Cquery

Dq

Attempts:

3 left

💡 Hint

Common Mistakes

Using parameter names that don't match the query string

Using descriptive names instead of actual query keys

The query parameter name should match the actual query key used in the URL, commonly 'q' for search queries.

4fill in blank

hard

Fill both blanks to document a POST endpoint with a JSON body parameter.

Express

/**
 * @route POST /users
 * @desc Create a new user
 * @param [1] body.object.required - user data
 * @param [2] body.object.required.name - user's name
 */
app.post('/users', (req, res) => { res.send('User created'); });

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

Auser

BuserData

Cusername

Dname

Attempts:

3 left

💡 Hint

Common Mistakes

Using inconsistent names between the object and its properties

Using property names that don't match the data structure

The body parameter is named 'userData' to represent the user object, and the nested property is 'name' for the user's name.

5fill in blank

hard

Fill all three blanks to document a response with status code and description.

Express

/**
 * @route DELETE /users/[1]
 * @desc Delete a user by ID
 * [2] id path.string.required - user ID
 * [3] 204 - No content
 */
app.delete('/users/:id', (req, res) => { res.status(204).send(); });

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

Aid

BuserId

C@param

D@returns

Attempts:

3 left

💡 Hint

Common Mistakes

Using wrong parameter names that don't match the route

Mixing up @param and @returns tags

The path parameter is named 'id', the tag for path parameters is '@param', and the tag for responses is '@returns'.

Practice

1. Which of the following is the most important reason to write clear API documentation in Express?

easy

A. To make your code run faster

B. To reduce the size of your project files

C. To help other developers understand how to use your API without confusion

D. To avoid writing tests for your API

Solution

1. Step 1: Understand the purpose of API documentation

   API documentation explains how to use the API, including routes, parameters, and responses.

2. Step 2: Identify the main benefit of clear documentation

   Clear docs help other developers use the API correctly without confusion or mistakes.

3. Final Answer:

   To help other developers understand how to use your API without confusion -> Option C

4. Quick Check:

   Clear docs = help others [OK]

Hint: Think about who reads your docs: other developers [OK]

Common Mistakes:

• Confusing documentation with code optimization
• Thinking docs reduce file size
• Assuming docs replace testing

2. Which syntax is the best way to add a comment describing an Express route for documentation?

easy

A. // This route returns all users

B.

C. # This route returns all users

D. /* This route returns all users */

Solution

1. Step 1: Identify the comment style used in JavaScript/Express

   Express uses JavaScript, which supports single-line comments with // and multi-line with /* */.

2. Step 2: Choose the correct comment syntax for a single line

   Single-line comments use //, so // This route returns all users is correct.

3. Final Answer:

   // This route returns all users -> Option A

4. Quick Check:

   JS single-line comment = // [OK]

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

Common Mistakes:

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

3. Given this Express route with JSDoc comments, what is the documented HTTP method and path?

/**
 * Get all products
 * @route GET /products
 * @returns {Array} List of products
 */
app.get('/products', (req, res) => { res.send([]); });

medium

A. GET /products

B. DELETE /products

C. GET /product

D. POST /products

Solution

1. Step 1: Read the JSDoc comment for the route

   The comment says @route GET /products, indicating the HTTP method and path.

2. Step 2: Match the comment with the Express route

   The code uses app.get('/products'), matching the GET method and /products path.

3. Final Answer:

   GET /products -> Option A

4. Quick Check:

   JSDoc @route matches app.get path [OK]

Hint: Look for @route tag in comments to find method and path [OK]

Common Mistakes:

• Confusing GET with POST or DELETE
• Ignoring the exact path string
• Assuming plural vs singular path names

4. You wrote this Express route but forgot to document the expected query parameter. What is the best fix?

app.get('/search', (req, res) => {
  const term = req.query.term;
  res.send(`Searching for ${term}`);
});

medium

A. Remove the query parameter from the code

B. Add a JSDoc comment describing the 'term' query parameter

C. Change the route to POST to avoid query parameters

D. Add a console.log statement inside the route

Solution

1. Step 1: Identify missing documentation

   The route uses req.query.term but no comment explains this parameter.

2. Step 2: Add clear documentation for the query parameter

   Use JSDoc to describe the 'term' parameter so users know what to send.

3. Final Answer:

   Add a JSDoc comment describing the 'term' query parameter -> Option B

4. Quick Check:

   Document all parameters for clarity [OK]

Hint: Document every input your API expects [OK]

Common Mistakes:

• Ignoring query parameters in docs
• Changing HTTP method unnecessarily
• Adding logs instead of docs

5. You want to keep your Express API documentation close to your code and automatically generate docs for users. Which approach is best?

hard

A. Write separate markdown files manually and update them after code changes

B. Only write comments in code without any generation tool

C. Create a PDF document describing the API and email it to users

D. Use JSDoc comments in your route files and a tool like swagger-jsdoc to generate docs

Solution

1. Step 1: Understand the goal of keeping docs close to code

   Keeping docs near code helps keep them updated and reduces errors.

2. Step 2: Identify tools that generate docs from code comments

   JSDoc comments combined with swagger-jsdoc can auto-generate API docs from code.

3. Step 3: Compare options

   Manual markdown or PDFs are separate and can get outdated; comments alone don't generate docs.

4. Final Answer:

   Use JSDoc comments in your route files and a tool like swagger-jsdoc to generate docs -> Option D

5. Quick Check:

   Auto-generate docs from code comments = best practice [OK]

Hint: Use tools that generate docs from code comments automatically [OK]

Common Mistakes:

• Writing docs separately and forgetting updates
• Not using any generation tool
• Relying on static PDFs