API documentation best practices in Express - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main purpose of API documentation in Express applications?

API documentation helps developers understand how to use the API endpoints, what data to send, and what responses to expect. It acts like a clear instruction manual for the API.

beginner

Name two popular tools used to create API documentation for Express apps.

Swagger (OpenAPI) and Postman are popular tools. Swagger lets you write structured docs that can generate interactive web pages. Postman helps test and document APIs with examples.

beginner

Why should API documentation include example requests and responses?

Examples show exactly how to call the API and what data to expect back. This makes it easier for developers to understand and use the API correctly without guessing.

intermediate

What is the benefit of keeping API documentation up to date in Express projects?

Up-to-date docs prevent confusion and errors. If the API changes but docs don’t, developers might use old info, causing bugs or failed requests.

intermediate

How can you organize API documentation for a large Express app with many endpoints?

Group endpoints by resource or feature, use clear headings, and provide a summary for each section. This helps users find info quickly and understand the API structure.

Which of the following is NOT a good practice for API documentation?

A Including example requests and responses

B Leaving out error response details

C Using clear and simple language

D Keeping documentation updated with API changes

Error response details are important so developers know how to handle failures. Leaving them out is not a good practice.

What tool can you use to generate interactive API docs from your Express app's code?

A Visual Studio Code

B GitHub

C Swagger (OpenAPI)

D Node Package Manager (npm)

Swagger (OpenAPI) can generate interactive documentation from structured API definitions.

Why is it important to document HTTP status codes in your API docs?

A Status codes are not important

B To confuse developers

C To make the docs longer

D To show what responses mean and how to handle them

Documenting status codes helps developers understand success and error responses.

How should you handle authentication details in API documentation?

A Explain how to authenticate and provide examples

B Only mention it in code comments

C Ignore them

D Put them in a separate private document

Clear instructions on authentication help users access protected endpoints correctly.

What is a benefit of using a tool like Postman for API documentation?

A It can test API endpoints and save example requests

B It replaces the need for any documentation

C It automatically fixes bugs in your API

D It writes backend code for you

Postman helps test APIs and create sharable documentation with examples.

Describe the key elements you should include in API documentation for an Express app.

Think about what a developer needs to successfully call and use your API.

Explain why keeping API documentation updated is crucial in Express projects.

Consider what happens if docs and code don’t match.

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