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.