Why API documentation matters in Express - Test Your Understanding

Practice - 5 Tasks

1fill in blank

easy

Complete the code to create a basic Express server.

Express

const express = require('express');
const app = express();
app.get('/', (req, res) => {
  res.send('Hello World!');
});
app.listen([1], () => console.log('Server running'));

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

Aexpress

B'3000'

Capp

D3000

Attempts:

3 left

💡 Hint

Common Mistakes

Using a string instead of a number for the port.

Passing the app or express object instead of a port number.

The listen method requires a port number as a number, not a string or other value.

2fill in blank

medium

Complete the code to parse JSON request bodies in Express.

Express

const express = require('express');
const app = express();
app.use([1]());

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

AbodyParser.json

BjsonParser

Cexpress.json

Dexpress.body

Attempts:

3 left

💡 Hint

Common Mistakes

Using bodyParser.json without importing body-parser.

Using incorrect middleware names.

Express has a built-in json middleware accessed by express.json().

3fill in blank

hard

Fix the error in the route handler to send a JSON response.

Express

app.get('/data', (req, res) => {
  res.[1]({ message: 'Hello API' });
});

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

AsendText

Bjson

CsendFile

DsendHtml

Attempts:

3 left

💡 Hint

Common Mistakes

Using res.sendText or res.sendHtml which are not valid Express methods.

Using res.sendFile for JSON data.

To send JSON data, use res.json() method.

4fill in blank

hard

Fill both blanks to create a route that accepts POST requests and reads JSON data.

Express

app.[1]('/submit', (req, res) => {
  const data = req.[2];
  res.json({ received: data });
});

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

Apost

Bbody

Cget

Dparams

Attempts:

3 left

💡 Hint

Common Mistakes

Using app.get instead of app.post for POST routes.

Accessing req.params instead of req.body for JSON data.

POST routes use app.post and JSON data is in req.body.

5fill in blank

hard

Fill all three blanks to create a simple Express API with a GET route that returns a JSON message.

Express

const express = require('express');
const app = express();
app.[1]('/hello', (req, res) => {
  res.[2]({ message: 'Hi there!' });
});
app.listen([3], () => console.log('API running'));

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

Aget

Bjson

C3000

Dpost

Attempts:

3 left

💡 Hint

Common Mistakes

Using app.post for a GET route.

Using res.send instead of res.json for JSON response.

Passing a string instead of a number for the port.

GET route uses app.get, sends JSON with res.json, and listens on port 3000.

Practice

1. Why is API documentation important when building an Express app?

easy

A. It helps users understand how to use the API correctly.

B. It makes the app run faster.

C. It automatically fixes bugs in the code.

D. It hides the API from users.

Solution

1. Step 1: Understand the purpose of API documentation

   API documentation explains how to use the API, making it easier for users to understand its functions.

2. Step 2: Identify the correct benefit

   Helping users understand usage prevents mistakes and confusion, which is the main goal of documentation.

3. Final Answer:

   It helps users understand how to use the API correctly. -> Option A

4. Quick Check:

   API documentation = clear usage guide [OK]

Hint: Documentation explains usage clearly to avoid confusion [OK]

Common Mistakes:

• Thinking documentation speeds up app performance
• Believing documentation fixes code bugs automatically
• Assuming documentation hides the API

2. Which of the following is the correct way to add a simple description in Express API documentation?

easy

A. Use comments like // This route gets user data above the route code.

B. Write the description inside the res.send() response.

C. Add the description as a variable inside the route handler.

D. Put the description in a separate CSS file.

Solution

1. Step 1: Identify how to document code in Express

   Comments using // are the standard way to add explanations in code files.

2. Step 2: Check other options for correctness

   Descriptions inside res.send() or variables do not serve as documentation, and CSS files are unrelated.

3. Final Answer:

   Use comments like // This route gets user data above the route code. -> Option A

4. Quick Check:

   Comments = code documentation [OK]

Hint: Use code comments for clear API explanations [OK]

Common Mistakes:

• Putting descriptions in response data
• Using unrelated files like CSS for docs
• Storing descriptions as variables

3. Given this Express route with documentation:

  // GET /hello returns a greeting message
  app.get('/hello', (req, res) => {
    res.send('Hello, world!');
  });

What will a user see when they visit /hello?

medium

A. A blank page with no content.

B. A JSON object with a greeting message.

C. An error message about missing documentation.

D. The text 'Hello, world!' displayed in the browser.

Solution

1. Step 1: Analyze the route handler code

   The route sends the string 'Hello, world!' as the response using res.send().

2. Step 2: Determine the output on visiting /hello

   The user will see the plain text 'Hello, world!' in their browser because that is the response content.

3. Final Answer:

   The text 'Hello, world!' displayed in the browser. -> Option D

4. Quick Check:

   res.send('Hello, world!') = text output [OK]

Hint: res.send sends text or data as response [OK]

Common Mistakes:

• Expecting JSON without using res.json()
• Thinking documentation affects output
• Assuming error without code issues

4. You wrote this Express route documentation and code:

  // POST /data saves user data
  app.post('/data', (req, res) => {
    res.send('Data saved');
  });

  // GET /data returns saved data
  app.get('/data', (req, res) => {
    res.send(savedData);
  });

But when testing, /data GET returns an error: ReferenceError: savedData is not defined. What is the problem?

medium

A. The POST route should use res.json() instead of res.send().

B. The variable savedData is not declared or initialized before use.

C. The GET route URL is incorrect and should be /get-data.

D. The documentation comments cause the error.

Solution

1. Step 1: Understand the error message

   The error says savedData is not defined, meaning the variable is missing in the code scope.

2. Step 2: Check the code for variable declaration

   There is no declaration or assignment for savedData shown, so the GET route tries to send an undefined variable.

3. Final Answer:

   The variable savedData is not declared or initialized before use. -> Option B

4. Quick Check:

   Undefined variable causes ReferenceError [OK]

Hint: Check if variables used in routes are declared [OK]

Common Mistakes:

• Blaming comments for runtime errors
• Confusing res.send and res.json for this error
• Changing route URL without reason

5. You want to improve your Express API documentation to help new developers. Which approach best achieves this?

hard

A. Use very technical language to show expertise, even if it confuses beginners.

B. Only write documentation for routes you think are important and skip the rest.

C. Write clear descriptions for each route, include example requests and responses, and update docs when code changes.

D. Avoid examples to keep documentation short and simple.

Solution

1. Step 1: Identify best documentation practices

   Good API docs have clear descriptions, examples, and stay updated with code changes.

2. Step 2: Evaluate options for helpfulness

   Skipping routes, using confusing language, or avoiding examples reduce documentation usefulness.

3. Final Answer:

   Write clear descriptions for each route, include example requests and responses, and update docs when code changes. -> Option C

4. Quick Check:

   Clear, example-rich, updated docs = best practice [OK]

Hint: Clear, example-filled, updated docs help everyone [OK]

Common Mistakes:

• Ignoring some routes in docs
• Using jargon that confuses readers
• Skipping examples to save time