SpringDoc OpenAPI setup in Spring Boot - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to add the SpringDoc OpenAPI dependency in Maven's <dependencies> section.

Spring Boot

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>[1]</artifactId>
    <version>1.7.0</version>
</dependency>

Drag options to blanks, or click blank then click option'

Aspringdoc-openapi-ui

Bspring-boot-starter-web

Cspringdoc-openapi-security

Dspring-boot-starter-data-jpa

Attempts:

3 left

💡 Hint

Common Mistakes

Using unrelated dependencies like spring-boot-starter-web.

Confusing security or JPA starters with OpenAPI UI.

The correct artifactId to add SpringDoc OpenAPI UI support is springdoc-openapi-ui.

2fill in blank

medium

Complete the annotation to define OpenAPI documentation metadata in a Spring Boot application.

Spring Boot

@[1]
@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

Drag options to blanks, or click blank then click option'

AEnableOpenApiDoc

BEnableSwagger2

CEnableOpenApi

DOpenAPIDefinition

Attempts:

3 left

💡 Hint

Common Mistakes

Using @EnableSwagger2 which is for older Swagger integration.

Using non-existent annotations like @EnableOpenApi.

The annotation @OpenAPIDefinition defines global OpenAPI metadata and supports documentation generation in SpringDoc.

3fill in blank

hard

Fix the error in the OpenAPI info bean definition by completing the missing method call.

Spring Boot

import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.OpenAPI;

@Bean
public OpenAPI customOpenAPI() {
    return new OpenAPI()
        .info(new Info().title("My API").version([1]));
}

Drag options to blanks, or click blank then click option'

A"1.0"

Bv1

C1.0

D"v1"

Attempts:

3 left

💡 Hint

Common Mistakes

Passing version without quotes causing a compile error.

Using incorrect version format.

The version must be a string, so it should be passed as "1.0".

4fill in blank

hard

Fill both blanks to configure the OpenAPI bean with a description and contact email.

Spring Boot

import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.OpenAPI;

@Bean
public OpenAPI apiInfo() {
    return new OpenAPI()
        .info(new Info()
            .description([1])
            .contact(new Contact().email([2])));
}

Drag options to blanks, or click blank then click option'

A"This is my API"

B"[e-mail]"

C"[e-mail]"

D"API description here"

Attempts:

3 left

💡 Hint

Common Mistakes

Swapping description and email values.

Not using quotes around strings.

The description is a string describing the API, and the contact email is a string email address.

5fill in blank

hard

Fill all three blanks to create a SpringDoc OpenAPI bean with title, version, and license name.

Spring Boot

import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import io.swagger.v3.oas.models.OpenAPI;

@Bean
public OpenAPI openApiConfig() {
    return new OpenAPI()
        .info(new Info()
            .title([1])
            .version([2])
            .license(new License().name([3])));
}

Drag options to blanks, or click blank then click option'

A"Sample API"

B"2.0"

C"Apache 2.0"

D"My API"

Attempts:

3 left

💡 Hint

Common Mistakes

Using unquoted strings causing errors.

Mixing up license and version values.

The title is a string naming the API, version is a string version number, and license name is a string naming the license.