Swagger UI integration in Express - Mini Project: Build & Apply

Swagger UI integration

📖 Scenario: You are building a simple Express server for a small web service. You want to add interactive API documentation so that users and developers can easily explore your API endpoints.

🎯 Goal: Integrate Swagger UI into your Express server to serve API documentation from a JSON specification file.

📋 What You'll Learn

Create an Express app instance

Add a Swagger JSON specification object

Use the swagger-ui-express middleware to serve the Swagger UI

Mount the Swagger UI at the '/api-docs' route

💡 Why This Matters

🌍 Real World

API documentation is essential for developers to understand and test your web services easily. Swagger UI integration provides a user-friendly interface to explore your API.

💼 Career

Many backend and full-stack developer roles require setting up API documentation. Knowing how to integrate Swagger UI with Express is a valuable skill for building maintainable APIs.

1

Create the Express app

Create a variable called express by requiring the 'express' module. Then create a variable called app by calling express().

Express

const express = require('express');
// Your code here

Hint

Use require('express') to import Express and then call it as a function to create your app.

2

Add the Swagger JSON specification

Create a constant called swaggerDocument and assign it an object with a swagger property set to '2.0', an info object with title 'Sample API' and version '1.0.0', and a paths object with a single path '/hello' that has a get method with a responses object containing a 200 response with a description 'Successful response'.

Express

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

// Create swaggerDocument object here
// Your code here

Hint

Define the Swagger JSON object exactly as described to describe your API.

3

Add swagger-ui-express middleware

Require the swagger-ui-express module into a constant called swaggerUi. Then use app.use to mount swaggerUi.serve and swaggerUi.setup(swaggerDocument) at the route '/api-docs'.

Express

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

const swaggerDocument = {
  swagger: '2.0',
  info: {
    title: 'Sample API',
    version: '1.0.0'
  },
  paths: {
    '/hello': {
      get: {
        responses: {
          '200': {
            description: 'Successful response'
          }
        }
      }
    }
  }
};

// Require swagger-ui-express and mount middleware at '/api-docs'
// Your code here

Hint

Use require('swagger-ui-express') and app.use to serve the Swagger UI at '/api-docs'.

4

Start the Express server

Add a call to app.listen on port 3000 with a callback function that logs the string 'Server running on port 3000'.

Express

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

const swaggerDocument = {
  swagger: '2.0',
  info: {
    title: 'Sample API',
    version: '1.0.0'
  },
  paths: {
    '/hello': {
      get: {
        responses: {
          '200': {
            description: 'Successful response'
          }
        }
      }
    }
  }
};

const swaggerUi = require('swagger-ui-express');
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

// Start server on port 3000
// Your code here

Hint

Use app.listen with a callback to start the server and log a message.

Practice

1. What is the main purpose of integrating swagger-ui-express in an Express app?

easy

A. To handle database connections automatically

B. To display API documentation in a user-friendly web page

C. To improve server performance by caching responses

D. To secure the API with authentication middleware

Solution

1. Step 1: Understand Swagger UI role

   Swagger UI provides a visual interface for API documentation, making it easier to explore and test endpoints.

2. Step 2: Identify middleware purpose

   swagger-ui-express middleware serves this UI in Express apps, not handling database or security tasks.

3. Final Answer:

   To display API documentation in a user-friendly web page -> Option B

4. Quick Check:

   Swagger UI = API docs display [OK]

Hint: Swagger UI shows API docs visually in browser [OK]

Common Mistakes:

• Confusing Swagger UI with security middleware
• Thinking it manages database connections
• Assuming it improves server speed

2. Which of the following is the correct way to import and use swagger-ui-express in an Express app?

easy

A. const swaggerUi = require('swagger-ui-express'); app.listen('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

B. import swaggerUi from 'swagger-ui-express'; app.get('/api-docs', swaggerUi.render(swaggerDocument));

C. const swaggerUi = require('swagger-ui-express'); app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

D. import swaggerUi from 'swagger-ui-express'; app.use('/api-docs', swaggerUi.render, swaggerUi.setup(swaggerDocument));

Solution

1. Step 1: Check import style

   Using CommonJS, require('swagger-ui-express') is correct for many Express apps.

2. Step 2: Verify middleware usage

   app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument)) correctly serves Swagger UI at the route.

3. Final Answer:

   const swaggerUi = require('swagger-ui-express'); app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument)); -> Option C

4. Quick Check:

   Correct import + middleware = const swaggerUi = require('swagger-ui-express'); app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument)); [OK]

Hint: Use require and app.use with serve and setup [OK]

Common Mistakes:

• Using app.listen instead of app.use for middleware
• Calling render instead of serve and setup
• Mixing import and require incorrectly

3. Given this Express code snippet, what will happen when you visit /api-docs in the browser?

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = { openapi: '3.0.0', info: { title: 'Test API', version: '1.0.0' }, paths: {} };
const app = express();
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
app.listen(3000);

medium

A. You will see a Swagger UI page showing 'Test API' with no endpoints

B. You will get a 404 Not Found error

C. The server will crash due to missing routes

D. You will see a blank page with no content

Solution

1. Step 1: Analyze swaggerDocument content

   The swaggerDocument defines basic API info with no paths, so UI will show API title but no endpoints.

2. Step 2: Understand middleware effect

   The middleware serves Swagger UI at /api-docs, so visiting that route shows the UI with given document.

3. Final Answer:

   You will see a Swagger UI page showing 'Test API' with no endpoints -> Option A

4. Quick Check:

   Swagger UI shows docs even if no paths [OK]

Hint: Swagger UI shows docs page even if paths empty [OK]

Common Mistakes:

• Expecting 404 if no API paths defined
• Thinking server crashes without routes
• Assuming blank page means error

4. You added Swagger UI to your Express app but visiting /api-docs shows a blank page. Which fix is most likely correct?

medium

A. Use app.get instead of app.use for Swagger UI

B. Change app.listen port to 8080

C. Remove the swaggerDocument argument from swaggerUi.setup

D. Ensure you use both swaggerUi.serve and swaggerUi.setup(swaggerDocument) in app.use

Solution

1. Step 1: Identify correct middleware usage

   Swagger UI requires both swaggerUi.serve to serve static files and swaggerUi.setup(swaggerDocument) to load docs.

2. Step 2: Understand common blank page cause

   Missing either part causes blank page because UI assets or docs are not served properly.

3. Final Answer:

   Ensure you use both swaggerUi.serve and swaggerUi.setup(swaggerDocument) in app.use -> Option D

4. Quick Check:

   Serve + setup needed for Swagger UI [OK]

Hint: Use both serve and setup middleware together [OK]

Common Mistakes:

• Using app.get instead of app.use for middleware
• Omitting swaggerDocument in setup
• Changing port unrelated to UI display

5. You want to add Swagger UI to your Express app but only show it in development mode. Which code snippet correctly achieves this?

hard

A. if (process.env.NODE_ENV === 'development') { app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument)); }

B. app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument)); if (process.env.NODE_ENV !== 'development') app.disable('/api-docs');

C. app.get('/api-docs', (req, res) => { if (process.env.NODE_ENV === 'development') swaggerUi.setup(swaggerDocument); else res.sendStatus(404); });

D. if (process.env.NODE_ENV !== 'development') { app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument)); }

Solution

1. Step 1: Check environment condition

   Using if (process.env.NODE_ENV === 'development') ensures Swagger UI middleware runs only in development.

2. Step 2: Confirm middleware usage

   Inside the condition, app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument)) correctly sets up Swagger UI.

3. Final Answer:

   if (process.env.NODE_ENV === 'development') { app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument)); } -> Option A

4. Quick Check:

   Conditionally add middleware in development only [OK]

Hint: Wrap middleware in if checking NODE_ENV === 'development' [OK]

Common Mistakes:

• Trying to disable route after adding middleware
• Using app.get without serving static files
• Reversing environment condition