S01L03 - Spring Boot, Comenzando con APIs RESTful

html

Construyendo un Proyecto Inicial de Spring Boot: Una Guía Completa
Tabla de Contenidos

Introducción
Configurando tu Entorno de Desarrollo
Creando un Proyecto Spring Boot
Configurando Dependencias
Desarrollando la API RESTful
Integrando SpringDoc para la Documentación de la API
Ejecutando y Probando tu Aplicación
Conclusión


Introducción
Bienvenido a esta guía completa sobre cómo construir un Spring Boot Starter Project. Ya seas un principiante que se aventura en el mundo de Spring Boot o un desarrollador con conocimientos básicos que busca perfeccionar sus habilidades, esta guía está diseñada para ti. Te guiaremos a través de todo el proceso, desde la configuración de tu entorno de desarrollo hasta la creación de una API RESTful completamente funcional con documentación integrada utilizando SpringDoc.
¿Por qué Spring Boot?
Spring Boot simplifica el desarrollo de aplicaciones basadas en Java al proporcionar configuraciones predeterminadas listas para producción y una gama de características listas para usar. Optimiza el proceso de configuración, permitiendo a los desarrolladores centrarse en escribir código en lugar de gestionar dependencias y configuraciones.
Propósito de Esta Guía
El propósito de esta guía es equiparte con el conocimiento y las habilidades prácticas para:

Configurar un proyecto Spring Boot usando Maven.
Configurar dependencias esenciales.
Desarrollar una API RESTful con documentación adecuada.
Entender las mejores prácticas para organizar y ejecutar tu aplicación Spring Boot.

Pros y Contras de Usar Spring Boot


Pros
Contras


Desarrollo rápido con configuración mínima
Puede ser abrumador para principiantes completos


Ecosistema extenso y soporte comunitario
Potencial de dependencia excesiva de configuraciones predeterminadas


Fácil integración con diversas tecnologías y herramientas
Curva de aprendizaje más pronunciada para características avanzadas


Cuándo y Dónde Usar Spring Boot
Spring Boot es ideal para:

Construir microservicios y aplicaciones independientes.
Desarrollar APIs RESTful.
Proyectos que requieren desarrollo y despliegue rápidos.
Aplicaciones que se benefician del robusto ecosistema e integraciones de Spring.


Configurando tu Entorno de Desarrollo
Antes de sumergirte en Spring Boot, asegúrate de que tu entorno de desarrollo esté correctamente configurado.
Requisitos Previos

Java Development Kit (JDK) 17: Spring Boot 3.x requiere JDK 17 o superior.
Maven: Para gestionar las dependencias del proyecto.
Visual Studio Code (VS Code): Un editor de código versátil.
Git: Para control de versiones (opcional pero recomendado).

Instalando JDK 17

Descarga el JDK desde el Sitio Web Oficial de Oracle: https://www.oracle.com/java/technologies/javase-jdk17-downloads.html.
Sigue las instrucciones de instalación para tu sistema operativo.
Verifica la instalación ejecutando:





		
		
			
			
Java
			
			java -version
			
				
					
				
					1
				
						java -version
					
				
			
		


Configurando Maven

Descarga Maven desde el Sitio Web Oficial de Apache Maven: https://maven.apache.org/download.cgi.
Extrae el archivo y añade el directorio bin al PATH de tu sistema.
Verifica la instalación:





		
		
			
			
Java
			
			mvn -version
			
				
					
				
					1
				
						mvn -version
					
				
			
		


Instalando Visual Studio Code

Descarga VS Code desde el Sitio Web Oficial: https://code.visualstudio.com/.
Sigue las instrucciones de instalación para tu sistema operativo.
Instala las extensiones necesarias para el desarrollo en Java y Spring Boot.


Creando un Proyecto Spring Boot
Spring Boot ofrece una manera intuitiva de iniciar tu aplicación usando el Spring Initializr.
Pasos para Crear un Proyecto

Navega a Spring Initializr:

    Abre tu navegador web y ve a https://start.spring.io/.
  
Configuración del Proyecto:

Project: Maven Project
Language: Java
Spring Boot: Versión 3.x (por ejemplo, 3.0.0)
Group: org.studyeasy
Artifact: spring-rest-demo
Name: spring-rest-demo
Description: A demo project for Spring Boot RESTful APIs


Versión de Java:

Selecciona Java 17 (versión LTS) para mayor estabilidad.


Dependencias:

Lombok: Simplifica el código Java reduciendo el código boilerplate.
Spring Web: Permite construir aplicaciones web, incluyendo RESTful.


Generar el Proyecto:

    Haz clic en el botón "Generate" para descargar el proyecto como un archivo .zip.
  
Extraer y Abrir en VS Code:

Extrae el archivo .zip descargado.
Abre VS Code.
Navega al directorio del proyecto y ábrelo usando el comando:







		
		
			
			
Java
			
			code .
			
				
					
				
					1
				
						code .
					
				
			
		



Configurando Dependencias
Spring Boot gestiona las dependencias a través de Maven, definidas en el archivo pom.xml. Exploraremos y añadiremos las dependencias necesarias para nuestro proyecto.
Entendiendo pom.xml
El archivo pom.xml gestiona las configuraciones del proyecto, incluyendo dependencias, plugins de construcción y más.
Agregando SpringDoc para la Documentación de la API
Para integrar la documentación de Swagger UI usando SpringDoc, agrega la siguiente dependencia:




		
		
			
			
Java
			
			&lt;dependency&gt;
    &lt;groupId&gt;org.springdoc&lt;/groupId&gt;
    &lt;artifactId&gt;springdoc-openapi-ui&lt;/artifactId&gt;
    &lt;version&gt;2.0.2&lt;/version&gt;
&lt;/dependency&gt;
			
				
					
				
					1
2
3
4
5
				
						&lt;dependency&gt;
    &lt;groupId&gt;org.springdoc&lt;/groupId&gt;
    &lt;artifactId&gt;springdoc-openapi-ui&lt;/artifactId&gt;
    &lt;version&gt;2.0.2&lt;/version&gt;
&lt;/dependency&gt;
					
				
			
		


Nota: Asegúrate de que la versión se alinee con los requisitos de Spring Boot 3.x.
Completo pom.xml
Aquí hay un extracto de la parte relevante del pom.xml con la dependencia de SpringDoc añadida:




		
		
			
			
Java
			
			&lt;dependencies&gt;
    &lt;!-- Lombok para reducir código boilerplate --&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;org.projectlombok&lt;/groupId&gt;
        &lt;artifactId&gt;lombok&lt;/artifactId&gt;
        &lt;version&gt;1.18.24&lt;/version&gt;
        &lt;scope&gt;provided&lt;/scope&gt;
    &lt;/dependency&gt;

    &lt;!-- Spring Web para construir APIs RESTful --&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
        &lt;artifactId&gt;spring-boot-starter-web&lt;/artifactId&gt;
    &lt;/dependency&gt;

    &lt;!-- SpringDoc para la integración de Swagger UI --&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;org.springdoc&lt;/groupId&gt;
        &lt;artifactId&gt;springdoc-openapi-ui&lt;/artifactId&gt;
        &lt;version&gt;2.0.2&lt;/version&gt;
    &lt;/dependency&gt;

    &lt;!-- Dependencias para Pruebas --&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
        &lt;artifactId&gt;spring-boot-starter-test&lt;/artifactId&gt;
        &lt;scope&gt;test&lt;/scope&gt;
    &lt;/dependency&gt;
&lt;/dependencies&gt;
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
				
						&lt;dependencies&gt;
    &lt;!-- Lombok para reducir código boilerplate --&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;org.projectlombok&lt;/groupId&gt;
        &lt;artifactId&gt;lombok&lt;/artifactId&gt;
        &lt;version&gt;1.18.24&lt;/version&gt;
        &lt;scope&gt;provided&lt;/scope&gt;
    &lt;/dependency&gt;
 
    &lt;!-- Spring Web para construir APIs RESTful --&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
        &lt;artifactId&gt;spring-boot-starter-web&lt;/artifactId&gt;
    &lt;/dependency&gt;
 
    &lt;!-- SpringDoc para la integración de Swagger UI --&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;org.springdoc&lt;/groupId&gt;
        &lt;artifactId&gt;springdoc-openapi-ui&lt;/artifactId&gt;
        &lt;version&gt;2.0.2&lt;/version&gt;
    &lt;/dependency&gt;
 
    &lt;!-- Dependencias para Pruebas --&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
        &lt;artifactId&gt;spring-boot-starter-test&lt;/artifactId&gt;
        &lt;scope&gt;test&lt;/scope&gt;
    &lt;/dependency&gt;
&lt;/dependencies&gt;
					
				
			
		



Desarrollando la API RESTful
Con las dependencias configuradas, vamos a crear una API RESTful simple que devuelve un mensaje "Hello World".
Creando la Clase de la Aplicación
Ubicación: src/main/java/org/studyeasy/SpringRestdemo/SpringRestdemoApplication.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringRestdemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringRestdemoApplication.class, args);
    }
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
				
						package org.studyeasy.SpringRestdemo;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
public class SpringRestdemoApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(SpringRestdemoApplication.class, args);
    }
}
					
				
			
		


Explicación:

@SpringBootApplication: Marca esta clase como el punto de entrada para la aplicación Spring Boot.
método main: Inicia la aplicación.

Creando el Account Controller
Ubicación: src/main/java/org/studyeasy/SpringRestdemo/controller/AccountController.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class AccountController {

    // Endpoint para devolver un saludo simple
    @GetMapping("/")
    public String demo() {
        return "Hello World";
    }
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
				
						package org.studyeasy.SpringRestdemo.controller;
 
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class AccountController {
 
    // Endpoint para devolver un saludo simple
    @GetMapping("/")
    public String demo() {
        return "Hello World";
    }
}
					
				
			
		


Explicación:

@RestController: Indica que esta clase maneja las solicitudes de la API REST.
@GetMapping("/"): Mapea las solicitudes HTTP GET al método demo.
método demo: Devuelve una cadena "Hello World" como respuesta.


Integrando SpringDoc para la Documentación de la API
La documentación es crucial para entender y utilizar las APIs de manera efectiva. SpringDoc facilita la integración sin problemas de Swagger UI para la documentación de la API.
Accediendo a la Documentación de la API
Una vez integrada, SpringDoc proporciona dos endpoints principales:

Documentos API Crudos: Accesible en http://localhost:8080/v3/api-docs
Swagger UI: Accesible en http://localhost:8080/swagger-ui.html

Beneficios de Usar SpringDoc

Documentación Generada Automáticamente: Elimina los esfuerzos de documentación manual.
UI Interactiva: Permite a los usuarios probar los endpoints de la API directamente desde el navegador.
Personalización: Ofrece flexibilidad para adaptar la documentación según las necesidades del proyecto.


Ejecutando y Probando tu Aplicación
Con todo configurado, vamos a ejecutar y probar nuestra aplicación Spring Boot.
Iniciando la Aplicación

Usando el Terminal de VS Code:





		
		
			
			
Java
			
			mvn spring-boot:run
			
				
					
				
					1
				
						mvn spring-boot:run
					
				
			
		



Primer Inicio:

Puede tomar algún tiempo mientras se resuelven las dependencias y la aplicación se inicializa.
Una vez iniciada, verás registros indicando que la aplicación está corriendo.



Verificando la Aplicación

Accediendo al Endpoint Raíz:

Abre tu navegador web.
Navega a http://localhost:8080/.
Salida:







		
		
			
			
Java
			
			Hello World
			
				
					
				
					1
				
						Hello World
					
				
			
		



Viendo la Documentación de la API:

Documentos Crudos: Visita http://localhost:8080/v3/api-docs para ver la representación JSON de tu API.
Swagger UI: Navega a http://localhost:8080/swagger-ui.html para una interfaz interactiva.
Salida de Swagger:

        
      
Interactuar con la API:

Usa el Swagger UI para enviar una solicitud GET al endpoint /.
Respuesta:









		
		
			
			
Java
			
			"Hello World"
			
				
					
				
					1
				
						"Hello World"
					
				
			
		


Entendiendo la Salida
La respuesta exitosa confirma que:

La aplicación Spring Boot está corriendo correctamente.
El endpoint de la API RESTful está operativo.
La integración de SpringDoc está funcionando, proporcionando documentación accesible.


Conclusión
¡Felicidades! Has construido exitosamente un Spring Boot Starter Project con una API RESTful y documentación integrada de Swagger UI utilizando SpringDoc. Esta configuración fundamental allana el camino para desarrollar APIs más complejas, integrar bases de datos, manejar seguridad y mucho más.
Principales Conclusiones

Spring Boot Simplifica el Desarrollo: Configura y establece tu aplicación rápidamente con un esfuerzo mínimo.
Maven Gestiona las Dependencias Eficientemente: Asegura que tu proyecto tenga todas las librerías y herramientas necesarias.
SpringDoc Mejora la Documentación: Proporciona una documentación clara e interactiva de la API, mejorando la usabilidad y mantenimiento.
La Práctica Práctica es Crucial: Construir y ejecutar tus propios proyectos solidifica la comprensión y revela desafíos del mundo real.

Siguientes Pasos

Mejora tu API: Añade más endpoints, maneja diferentes métodos HTTP e implementa lógica de negocio.
Integra Bases de Datos: Conecta tu aplicación a bases de datos como MySQL o PostgreSQL para la persistencia de datos.
Implementa Seguridad: Asegura tus APIs usando Spring Security y OAuth2.
Explora Características Avanzadas de Spring Boot: Profundiza en temas como arquitectura de microservicios, pruebas y estrategias de despliegue.


Nota: Este artículo es generado por IA.
S01L03 – Spring Boot, Comenzando con APIs RESTful

Construyendo un Proyecto Inicial de Spring Boot: Una Guía Completa

Tabla de Contenidos

Introducción

¿Por qué Spring Boot?

Propósito de Esta Guía

Pros y Contras de Usar Spring Boot

Cuándo y Dónde Usar Spring Boot

Configurando tu Entorno de Desarrollo

Requisitos Previos

Instalando JDK 17

Configurando Maven

Instalando Visual Studio Code

Creando un Proyecto Spring Boot

Pasos para Crear un Proyecto

Configurando Dependencias

Entendiendo `pom.xml`

Agregando SpringDoc para la Documentación de la API

Completo `pom.xml`

Desarrollando la API RESTful

Creando la Clase de la Aplicación

Creando el Account Controller

Integrando SpringDoc para la Documentación de la API

Accediendo a la Documentación de la API

Beneficios de Usar SpringDoc

Ejecutando y Probando tu Aplicación

Iniciando la Aplicación

Verificando la Aplicación

Entendiendo la Salida

Conclusión

Principales Conclusiones

Siguientes Pasos

Pros	Contras
Desarrollo rápido con configuración mínima	Puede ser abrumador para principiantes completos
Ecosistema extenso y soporte comunitario	Potencial de dependencia excesiva de configuraciones predeterminadas
Fácil integración con diversas tecnologías y herramientas	Curva de aprendizaje más pronunciada para características avanzadas