Swagger UI integration in Express

Introduction

Swagger UI helps you see and test your API in a simple web page. It makes understanding and using your API easier.

You want to show your API details to other developers clearly.

You want to test your API endpoints without writing extra code.

You want to keep your API documentation updated automatically.

You want a friendly interface to explore your API during development.

Syntax

Express

import express from 'express';
import swaggerUi from 'swagger-ui-express';
import swaggerDocument from './swagger.json' assert { type: 'json' };

const app = express();

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

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

Use swagger-ui-express package to serve Swagger UI in Express.

The Swagger document is usually a JSON file describing your API.

Examples

This example serves Swagger UI at the /docs URL path.

Express

import swaggerUi from 'swagger-ui-express';
import swaggerDocument from './swagger.json' assert { type: 'json' };

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

Enables the explorer feature to allow searching and filtering in Swagger UI.

Express

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, { explorer: true }));

Sample Program

This Express app has a simple /hello endpoint and serves Swagger UI at /api-docs. The Swagger JSON file describes the API endpoints.

Express

import express from 'express';
import swaggerUi from 'swagger-ui-express';
import swaggerDocument from './swagger.json' assert { type: 'json' };

const app = express();

app.get('/hello', (req, res) => {
  res.json({ message: 'Hello, world!' });
});

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

app.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
  console.log('Swagger UI available at http://localhost:3000/api-docs');
});

Important Notes

Make sure your Swagger JSON file is valid and describes your API correctly.

You can customize Swagger UI appearance and behavior with options in swaggerUi.setup().

Use browser developer tools to inspect the Swagger UI page and debug if needed.

Summary

Swagger UI integration shows your API in a friendly web page.

Use swagger-ui-express middleware in Express to serve it.

Keep your Swagger JSON updated to reflect your API changes.

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