Why API documentation matters in Express - See It in Action

Why API documentation matters

📖 Scenario: You are building a simple Express server that provides information about books. Good API documentation helps other developers understand how to use your server endpoints correctly.

🎯 Goal: Create a basic Express server with a single endpoint /books that returns a list of books. Add clear comments to document the API endpoint, explaining what it does and how to use it.

📋 What You'll Learn

Create an Express app with a /books GET endpoint

Define a list of books as an array of objects with id and title

Add a configuration variable for the port number

Add comments above the endpoint to document its purpose and usage

Start the server listening on the configured port

💡 Why This Matters

🌍 Real World

API documentation helps developers understand how to use your server endpoints without confusion, saving time and reducing mistakes.

💼 Career

Clear API documentation is a key skill for backend developers and anyone working with web services or APIs.

1

DATA SETUP: Create the books data array

Create a constant array called books with these exact objects: { id: 1, title: '1984' }, { id: 2, title: 'Brave New World' }, and { id: 3, title: 'Fahrenheit 451' }.

Express

// Create the books array with 3 book objects
// Your code here

Hint

Use const books = [ ... ] with three objects inside.

2

CONFIGURATION: Set the server port

Create a constant called PORT and set it to 3000.

Express

const books = [
  { id: 1, title: '1984' },
  { id: 2, title: 'Brave New World' },
  { id: 3, title: 'Fahrenheit 451' }
];

// Set the server port to 3000
// Your code here

Hint

Use const PORT = 3000; to set the port.

3

CORE LOGIC: Create the Express app and the /books endpoint

Import Express, create an app with express(), and add a GET endpoint /books that sends the books array as JSON.

Express

const books = [
  { id: 1, title: '1984' },
  { id: 2, title: 'Brave New World' },
  { id: 3, title: 'Fahrenheit 451' }
];

const PORT = 3000;

// Import express and create app
// Add GET /books endpoint to send books as JSON
// Your code here

Hint

Use const express = require('express'); and const app = express();. Then add app.get('/books', (req, res) => { res.json(books); });.

4

COMPLETION: Add API documentation comments and start the server

Add a comment above the /books endpoint explaining it returns a list of books as JSON. Then add app.listen(PORT) to start the server.

Express

const express = require('express');
const app = express();

const books = [
  { id: 1, title: '1984' },
  { id: 2, title: 'Brave New World' },
  { id: 3, title: 'Fahrenheit 451' }
];

const PORT = 3000;

// Add a comment describing the /books endpoint
// Start the server listening on PORT
// Your code here

Hint

Add a comment like // GET /books endpoint returns a list of books as JSON above the endpoint. Then add app.listen(PORT); below.

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