Implementar SpringDoc OpenAPI |Swagger en Java Spring en 2 PASOS

 Implementar Swagger en Java Spring 

Te ayudaré a crear una introducción atractiva para tu blog sobre la implementación de Swagger en Java Spring.

En el dinámico mundo del desarrollo de APIs REST, la documentación clara y accesible se ha convertido en un elemento crucial para el éxito de cualquier proyecto. Swagger, también conocido como OpenAPI, se ha establecido como el estándar de facto para documentar APIs de manera elegante y eficiente. Cuando se combina con Spring Framework, uno de los frameworks más populares en el ecosistema Java, obtenemos una poderosa herramienta que no solo mejora la documentación de nuestras APIs, sino que también facilita enormemente su prueba y mantenimiento.

En este artículo, exploraremos paso a paso cómo integrar Swagger en tus aplicaciones Java Spring, transformando la tediosa tarea de documentar APIs en un proceso fluido y automatizado. Ya seas un desarrollador experimentado buscando optimizar tu flujo de trabajo o estés comenzando tu viaje en el desarrollo de APIs REST, esta guía te proporcionará las herramientas necesarias para elevar la calidad de tu documentación al siguiente nivel.

Paso 1. 

En 2025 estaremos usando SpringDoc ya que es mas compatible. Por lo que implementamos la dependencia necesaria. Maven Repository: org.springdoc » springdoc-openapi-starter-webmvc-ui

Por lo que nuestro archivo Gradle debe quedar de esta manera: 

implementation ("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0")

Paso 2. 

En nuestro package donde tenemos los controladores crea otro package de configuración. OJO: no dentro de controladores, si no al mismo nivel es decir: 
-Web

    -Controladores

    -Config 

Y entonces en Config crea tu archivo quedando de la siguiente manera: 

package com.example.demo.web.config;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.Collections;

@Configuration
public class SwaggerConfig {

    @Bean
    public OpenAPI apiInfo() {
        return new OpenAPI()
                .info(new Info()
                        .title("Mi API REST")
                        .description("Descripción de mi API")
                        .version("1.0")
                        .contact(new Contact()
                                .name("Tu Nombre")
                                .email("email@example.com")
                                .url("www.example.com"))
                        .license(new License()
                                .name("Licencia")
                                .url("URL de la licencia")));
    }

}

¡Listo!