Swagger UI integration in Express - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Swagger UI used for in an Express application?

Swagger UI provides a visual interface to explore and test API endpoints defined in your Express app. It helps developers and users understand how to use the API easily.

beginner

Which npm packages are commonly used to integrate Swagger UI with Express?

The main packages are swagger-ui-express to serve the UI and swagger-jsdoc to generate Swagger specification from JSDoc comments.

intermediate

How do you serve Swagger UI at the route /api-docs in Express?

You use app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec)) where swaggerSpec is your Swagger JSON specification.

intermediate

What is the role of the Swagger specification (swaggerSpec) in Swagger UI integration?

It defines the API structure, endpoints, parameters, and responses in a JSON format that Swagger UI reads to generate the interactive documentation.

intermediate

Why is it helpful to write JSDoc comments in your Express routes when using swagger-jsdoc?

JSDoc comments let you describe your API endpoints directly in code. swagger-jsdoc reads these comments to automatically build the Swagger specification, saving time and reducing errors.

Which package do you use to serve Swagger UI in an Express app?

A swagger-ui-express

B express-swagger

C swagger-ui

D swagger-jsdoc

swagger-ui-express is the package designed to serve Swagger UI in Express apps.

Where do you usually mount Swagger UI in an Express app?

A /docs

B /swagger

C /swagger-ui

D /api-docs

The common convention is to mount Swagger UI at /api-docs.

What format does Swagger UI expect for the API description?

A JSON or YAML

B XML

C YAML only

D Plain text

Swagger UI can read API specs in JSON or YAML formats.

What does swagger-jsdoc do?

A Generates Swagger UI interface

B Creates Swagger JSON from JSDoc comments

C Runs Express server

D Validates API requests

swagger-jsdoc reads JSDoc comments and creates the Swagger JSON specification.

Which Express method is used to add Swagger UI middleware?

A app.get()

B app.post()

C app.use()

D app.listen()

app.use() is used to add middleware like Swagger UI to a route.

Explain how to integrate Swagger UI into an Express app step-by-step.

Think about npm packages, generating specs, middleware, and routes.

Describe the benefits of using Swagger UI with Express APIs.

Consider how Swagger UI helps both developers and API consumers.