API documentation best practices in Express

Introduction

Good API documentation helps developers understand how to use your API easily. It saves time and reduces mistakes.

When creating a new API for others to use

When updating an existing API with new features

When sharing your API with teammates or external users

When you want to reduce support questions about your API

Syntax

Express

/*
  Route: GET /users
  Description: Returns a list of users
  Query Params:
    - page (optional): number, page number for pagination
  Response:
    200: JSON array of user objects
    400: Bad request error
*/

Use clear comments above your route handlers to explain their purpose.

Include HTTP method, URL, parameters, and response details.

Examples

This documents a login route with required body parameters and possible responses.

Express

/*
  Route: POST /login
  Description: Authenticates a user
  Body Params:
    - username: string, required
    - password: string, required
  Response:
    200: JSON with auth token
    401: Unauthorized error
*/

This documents a delete user route with URL parameter and response codes.

Express

/*
  Route: DELETE /users/:id
  Description: Deletes a user by ID
  URL Params:
    - id: string, required
  Response:
    204: No content on success
    404: User not found
*/

Sample Program

This Express app has a documented GET /items route. It explains the optional query parameter and the response format.

Express

import express from 'express';
const app = express();
app.use(express.json());

/*
  Route: GET /items
  Description: Returns all items
  Query Params:
    - limit (optional): number, max items to return
  Response:
    200: JSON array of items
*/
app.get('/items', (req, res) => {
  const limit = parseInt(req.query.limit) || 10;
  const items = Array.from({ length: 20 }, (_, i) => ({ id: i + 1, name: `Item ${i + 1}` }));
  res.json(items.slice(0, limit));
});

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

Important Notes

Keep your documentation up to date as your API changes.

Use tools like Swagger or OpenAPI for interactive docs if possible.

Write examples for requests and responses to help users understand usage.

Summary

Good API docs explain routes, parameters, and responses clearly.

Use comments or tools to keep docs close to your code.

Clear docs help others use your API without confusion.

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