SpringDoc OpenAPI setup in Spring Boot - Practice Problems & Coding Challenges

Challenge - 5 Problems

❓ component_behavior

intermediate

What is the default OpenAPI path after adding SpringDoc dependency?

After adding the SpringDoc OpenAPI dependency to a Spring Boot project, which URL path will serve the OpenAPI JSON specification by default?

A /openapi.json

B /swagger-ui.html

C /v3/api-docs

D /api-docs

💡 Hint

Think about the default endpoint SpringDoc uses to expose the raw OpenAPI JSON.

The default path for the OpenAPI JSON spec in SpringDoc is /v3/api-docs. The Swagger UI is served separately.

📝 Syntax

intermediate

Which dependency is required for SpringDoc OpenAPI in Maven?

Select the correct Maven dependency snippet to add SpringDoc OpenAPI UI support in a Spring Boot project.

A

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-ui</artifactId>
  <version>1.7.0</version>
</dependency>

B

<dependency>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-ui</artifactId>
  <version>3.0.0</version>
</dependency>

C

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>

D

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-webmvc-core</artifactId>
  <version>1.7.0</version>
</dependency>

💡 Hint

Look for the artifact that includes UI support for SpringDoc.

The springdoc-openapi-ui artifact provides the Swagger UI integration for SpringDoc.

🔧 Debug

advanced

Why does Swagger UI not load after adding SpringDoc?

You added SpringDoc OpenAPI UI dependency and started your Spring Boot app. Accessing /swagger-ui.html returns 404. What is the most likely cause?

A You forgot to add <code>@EnableSwagger2</code> annotation in your main class.

B The correct URL is <code>/swagger-ui/index.html</code> or <code>/swagger-ui.html</code> is deprecated in newer SpringDoc versions.

C Spring Boot version is incompatible with SpringDoc and needs to be downgraded.

D You need to manually create a controller to serve Swagger UI static files.

💡 Hint

Check the official SpringDoc documentation for the correct Swagger UI URL.

In recent SpringDoc versions, /swagger-ui.html is replaced by /swagger-ui/index.html. The @EnableSwagger2 annotation is for older Swagger 2 setups, not SpringDoc.

❓ state_output

advanced

What is the effect of setting springdoc.api-docs.path in application.properties?

If you set springdoc.api-docs.path=/custom-api-docs in your Spring Boot application.properties, what will be the new URL to access the OpenAPI JSON spec?

A /custom-api-docs

B /v3/api-docs

C /swagger-ui/custom-api-docs

D /api-docs/custom

💡 Hint

This property changes the base path for the OpenAPI JSON output.

Setting springdoc.api-docs.path changes the endpoint where the OpenAPI JSON is served. So it moves from /v3/api-docs to the custom path.

🧠 Conceptual

expert

How does SpringDoc integrate with Spring Boot to generate OpenAPI docs?

Which best describes how SpringDoc generates OpenAPI documentation in a Spring Boot application?

A SpringDoc replaces Spring MVC with a custom web framework to expose API docs.

B SpringDoc requires manual JSON files to be written and served by the application.

C SpringDoc uses compile-time code generation to create static OpenAPI files.

D SpringDoc scans Spring MVC controllers and their annotations at runtime to build the OpenAPI spec dynamically.

💡 Hint

Think about how SpringDoc uses existing code and annotations to create docs.

SpringDoc dynamically scans your Spring MVC controllers and their annotations like @GetMapping and @Operation to generate the OpenAPI spec at runtime.