Swagger in Spring Boot 3.0

Mauricio Huertas T. — Sat, 06 Jan 2024 13:40:26 +0000

Title: How to Install Swagger in Spring Boot 3.0 with Maven

If you're working on a Spring Boot 3.0 project and want to integrate Swagger for documenting and visualizing your API, follow these simple steps.

First, add the following dependency to your pom.xml file:

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.2.0</version>
</dependency>

Then, in your application properties, include the following configuration to sort operations in the Swagger UI:

springdoc.swagger-ui.operationsSorter=method

If you have Spring Security installed, it's crucial to allow Swagger to display. Add specific rules, for example:

return http
    .cors(c -> corsConfigurationSource())
    .csrf(csrf -> csrf.disable())
    .authorizeHttpRequests(auth -> auth
        .requestMatchers("/v3/api-docs")
        .permitAll()
        .requestMatchers("/swagger-ui/**")
        .permitAll()
        .requestMatchers("/v3/api-docs/swagger-config")
        .permitAll()
        .anyRequest()
        .authenticated());

For more configuration, create a SwaggerConfig class with the following content:

@Bean
public OpenAPI openAPI() {
    return new OpenAPI()
            .addSecurityItem(new SecurityRequirement().addList(token))
            .components(new Components().addSecuritySchemes(tokenApp, createAPIKeyScheme()))
            .info(new Info()
                    .title("Web service API")
                    .description("API Access for applications")
                    .version("1.0.0")
                    .contact(new Contact()
                            .name("EmSolution")
                            .email("info@emsolution.com")
                            .url("www.emsolution.com"))
                    .license(new License().name("License of API")
                            .url("API license URL")));
}

private SecurityScheme createAPIKeyScheme() {
    return new SecurityScheme().type(SecurityScheme.Type.APIKEY)
            .in(SecurityScheme.In.HEADER)
            .name(tokenApp);
}

That's it! Now you'll have Swagger integrated into your Spring Boot 3.0 project. Feel free to leave your comments and questions. Cheers!

"Finally, I appreciate your time in reading this article and hope to have your support."

Ing. Mauricio Huertas T.

Swagger en Spring Boot 3.0

Mauricio Huertas T. — Sat, 06 Jan 2024 13:35:16 +0000

Cómo Instalar Swagger en Spring Boot 3.0 con Maven

Si estás trabajando en un proyecto Spring Boot 3.0 y deseas integrar Swagger para documentar y visualizar tu API, sigue estos pasos sencillos.

Primero, añade la siguiente dependencia a tu archivo pom.xml:

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.2.0</version>
</dependency>

Luego, en las propiedades de tu aplicación, incluye la siguiente configuración para ordenar las operaciones en la interfaz de usuario de Swagger:

springdoc.swagger-ui.operationsSorter=method

Si estás utilizando Spring Security, es importante permitir que Swagger se muestre. Añade reglas específicas, por ejemplo:

return http
    .cors(c -> corsConfigurationSource())
    .csrf(csrf -> csrf.disable())
    .authorizeHttpRequests(auth -> auth
        .requestMatchers("/v3/api-docs")
        .permitAll()
        .requestMatchers("/swagger-ui/**")
        .permitAll()
        .requestMatchers("/v3/api-docs/swagger-config")
        .permitAll()
        .anyRequest()
        .authenticated());

Si deseas una configuración más detallada, crea una clase SwaggerConfig con el siguiente contenido:

@Bean
public OpenAPI openAPI() {
    return new OpenAPI()
            .addSecurityItem(new SecurityRequirement().addList(token))
            .components(new Components().addSecuritySchemes(tokenApp, createAPIKeyScheme()))
            .info(new Info()
                    .title("Web service API")
                    .description("API de acceso a aplicaciones")
                    .version("1.0.0")
                    .contact(new Contact()
                            .name("EmSolucion")
                            .email("info@emsolucion.com")
                            .url("www.emsolucion.com"))
                    .license(new License().name("Licencia de API")
                            .url("URL de la licencia de la API")));
}

private SecurityScheme createAPIKeyScheme() {
    return new SecurityScheme().type(SecurityScheme.Type.APIKEY)
            .in(SecurityScheme.In.HEADER)
            .name(tokenApp);
}

¡Listo! Ahora tendrás Swagger integrado en tu proyecto Spring Boot 3.0. No dudes en dejar tus comentarios y preguntas. ¡Saludos!

"Finalmente, agradezco tu tiempo al leer este artículo y espero contar con tu apoyo."

Ing. Mauricio Huertas T.

DEV Community: Mauricio Huertas T.

Swagger in Spring Boot 3.0

Swagger en Spring Boot 3.0