Swagger/OpenAPI specification in Express - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the Swagger/OpenAPI specification in Express applications?

It is a standard way to describe RESTful APIs so that humans and computers can understand the API's structure, endpoints, and data formats clearly.

beginner

What file format is commonly used to write Swagger/OpenAPI specifications?

Swagger/OpenAPI specifications are commonly written in JSON or YAML format.

beginner

In Swagger/OpenAPI, what is an "endpoint"?

An endpoint is a URL path in the API where a client can send requests to perform actions like getting data or sending data.

intermediate

How does Swagger UI help developers working with Express APIs?

Swagger UI generates a web page that shows the API documentation interactively, letting developers try out API calls directly from the browser.

intermediate

What is the role of the 'paths' object in a Swagger/OpenAPI specification?

The 'paths' object lists all the API endpoints and defines the HTTP methods (GET, POST, etc.) and details like parameters and responses for each endpoint.

Which of the following is NOT a valid HTTP method in Swagger/OpenAPI paths?

A FETCH

B POST

C GET

D DELETE

FETCH is not a standard HTTP method; GET, POST, and DELETE are valid HTTP methods used in Swagger/OpenAPI.

What does the 'components' section in an OpenAPI spec usually contain?

A API endpoint URLs

B Server configuration

C Reusable schemas, parameters, and responses

D User authentication tokens

The 'components' section holds reusable parts like data schemas, parameters, and response definitions.

Which tool can automatically generate interactive API docs from a Swagger/OpenAPI spec in Express?

A Node.js

B Swagger UI

C Express Router

D Postman

Swagger UI creates interactive documentation from the OpenAPI spec.

In an OpenAPI spec, where do you define the expected data format for a request body?

A Under 'paths' > method > 'requestBody'

B Under 'servers'

C Under 'info'

D Under 'tags'

The 'requestBody' section inside a path's method defines the data format expected in the request.

What is the main benefit of using Swagger/OpenAPI with Express APIs?

A It manages database connections

B It automatically writes backend code

C It replaces Express routing

D It documents APIs clearly and helps testing

Swagger/OpenAPI helps document APIs clearly and provides tools for testing them.

Explain how Swagger/OpenAPI specification improves communication between backend developers and frontend developers.

Think about how a clear map helps travelers find their way.

Describe the steps to add Swagger UI to an Express app to show API documentation.

Focus on setup and middleware integration.

Practice

1. What is the main purpose of using Swagger/OpenAPI specification in an Express app?

easy

A. To speed up the server response time

B. To clearly describe and document the API endpoints and their behavior

C. To automatically fix bugs in the code

D. To encrypt the API data for security

Solution

1. Step 1: Understand Swagger/OpenAPI role

   Swagger/OpenAPI is used to describe APIs so others can understand how to use them.

2. Step 2: Identify main purpose in Express

   It helps document endpoints, request parameters, and responses clearly.

3. Final Answer:

   To clearly describe and document the API endpoints and their behavior -> Option B

4. Quick Check:

   Swagger documents APIs clearly [OK]

Hint: Swagger is for API documentation, not performance or security [OK]

Common Mistakes:

• Thinking Swagger speeds up the server
• Confusing Swagger with security tools
• Assuming Swagger fixes code bugs automatically

2. Which of the following is the correct way to set up swagger-ui-express middleware in an Express app?

easy

A. app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

B. app.get('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

C. app.listen('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

D. app.post('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

Solution

1. Step 1: Recall Express middleware usage

   Middleware is added with app.use() for routes serving static or UI content.

2. Step 2: Identify swagger-ui-express setup

   swaggerUi.serve and swaggerUi.setup() are passed as middleware to app.use() for '/api-docs'.

3. Final Answer:

   app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument)); -> Option A

4. Quick Check:

   Use app.use for middleware setup [OK]

Hint: Use app.use for middleware, not app.get or app.listen [OK]

Common Mistakes:

• Using app.get instead of app.use for middleware
• Trying to listen on a route path
• Using app.post for serving docs

3. Given this Swagger snippet in an Express app, what HTTP method and path does it describe?

{
  "paths": {
    "/users": {
      "post": {
        "summary": "Create a new user",
        "responses": {
          "201": {"description": "User created"}
        }
      }
    }
  }
}

medium

A. POST request to /users

B. DELETE request to /users

C. PUT request to /users

D. GET request to /users

Solution

1. Step 1: Read the Swagger path and method

   The snippet shows a path '/users' with a 'post' method defined.

2. Step 2: Match HTTP method and path

   The method is POST, and the path is '/users', meaning it creates a new user.

3. Final Answer:

   POST request to /users -> Option A

4. Quick Check:

   Method 'post' means POST request [OK]

Hint: Look for HTTP method keys like 'get', 'post' in paths [OK]

Common Mistakes:

• Confusing 'post' with 'get'
• Ignoring the path and focusing on responses
• Assuming default method is GET

4. You wrote this Swagger setup in your Express app but the docs page shows a blank screen:

import swaggerUi from 'swagger-ui-express';
import swaggerDocument from './swagger.json';

app.use('/docs', swaggerUi.serve, swaggerUi.setup());

What is the likely error?

medium

A. swagger.json file path is incorrect

B. Wrong import syntax for swagger-ui-express

C. Using app.use instead of app.get for docs route

D. Missing swaggerDocument argument in swaggerUi.setup()

Solution

1. Step 1: Check swaggerUi.setup() usage

   swaggerUi.setup() requires the Swagger document as an argument to display docs.

2. Step 2: Identify missing argument

   The code calls swaggerUi.setup() without passing swaggerDocument, so no docs load.

3. Final Answer:

   Missing swaggerDocument argument in swaggerUi.setup() -> Option D

4. Quick Check:

   Always pass Swagger JSON to swaggerUi.setup() [OK]

Hint: Always pass your Swagger JSON to swaggerUi.setup() [OK]

Common Mistakes:

• Forgetting to pass swaggerDocument to setup()
• Using app.get instead of app.use for middleware
• Incorrect import syntax causing silent failure

5. You want to add a new GET endpoint '/products' with a query parameter 'category' described in your Swagger file. Which snippet correctly defines this parameter in OpenAPI 3.0?

hard

A. "parameters": [{"name": "category", "in": "header", "required": false, "schema": {"type": "string"}}]

B. "parameters": [{"name": "category", "in": "path", "required": true, "schema": {"type": "string"}}]

C. "parameters": [{"name": "category", "in": "query", "required": false, "schema": {"type": "string"}, "description": "Filter products by category"}]

D. "parameters": [{"name": "category", "in": "body", "required": true, "schema": {"type": "string"}}]

Solution

1. Step 1: Identify correct parameter location for query

   Query parameters use "in": "query" and are usually optional.

2. Step 2: Check parameter details

   "parameters": [{"name": "category", "in": "query", "required": false, "schema": {"type": "string"}, "description": "Filter products by category"}] correctly sets name, in, required false, type string, and description.

3. Final Answer:

   "parameters": [{"name": "category", "in": "query", "required": false, "schema": {"type": "string"}, "description": "Filter products by category"}] -> Option C

4. Quick Check:

   Query params use "in": "query" [OK]

Hint: Query params use "in": "query", path params use "in": "path" [OK]

Common Mistakes:

• Using "in": "path" for query parameters
• Setting required true for optional query params
• Using "in": "body" which is invalid in OpenAPI 3.0