Swagger UI integration in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Swagger UI used for in a Spring Boot project?

Swagger UI provides a visual interface to explore and test REST APIs directly from the browser, making it easier to understand and interact with the API endpoints.

beginner

Which dependency is commonly added to a Spring Boot project to enable Swagger UI?

The 'springdoc-openapi-ui' dependency is commonly used to integrate Swagger UI with Spring Boot, providing automatic API documentation and UI.

beginner

How do you access Swagger UI once integrated into a Spring Boot application?

After integration, Swagger UI is usually accessible at the URL path '/swagger-ui.html' or '/swagger-ui/index.html' in the running application.

beginner

What annotation is used to mark a Spring Boot controller to be included in Swagger documentation?

The '@RestController' annotation marks a class as a REST controller, and Swagger automatically includes its endpoints in the documentation.

intermediate

How can you customize the API information shown in Swagger UI in Spring Boot?

You can customize API info by creating a bean of type 'OpenAPI' and setting details like title, description, version, and contact information.

Which dependency should you add to a Spring Boot project to enable Swagger UI?

A org.springframework.boot:spring-boot-starter-web

B org.hibernate:hibernate-core

C org.apache.commons:commons-lang3

D org.springdoc:springdoc-openapi-ui

The 'springdoc-openapi-ui' dependency integrates Swagger UI with Spring Boot for API documentation.

What URL path typically shows the Swagger UI page in a Spring Boot app?

A /api-docs

B /swagger-ui.html

C /home

D /login

Swagger UI is usually accessible at '/swagger-ui.html' or '/swagger-ui/index.html' after integration.

Which annotation is used to define a REST controller for Swagger to document?

A @RestController

B @Component

C @Entity

D @Service

The '@RestController' annotation marks a class as a REST API controller, which Swagger documents.

How can you customize the API title and description in Swagger UI?

A By creating an OpenAPI bean with custom info

B By editing application.properties

C By changing the main class name

D By adding @CustomSwagger annotation

Creating an OpenAPI bean lets you set custom API info like title and description.

What is the main benefit of integrating Swagger UI in Spring Boot?

A Faster database queries

B Improved security

C Visual API documentation and testing

D Automatic UI themes

Swagger UI provides a visual interface to explore and test APIs easily.

Explain how to add Swagger UI to a Spring Boot project and access the API documentation.

Think about dependencies and the URL path for Swagger UI.

Describe how to customize the API information shown in Swagger UI in Spring Boot.

Customization involves creating a configuration bean.