Creación de Controlador REST en Spring Boot

Clase 24 de 35Curso de Java Spring

Resumen

¿Cómo crear un controlador REST en Spring?

Crear un controlador REST es un paso fundamental para construir una API eficiente y bien estructurada en Spring. A continuación, se expone una guía paso a paso para configurar tu primer controlador REST utilizando las anotaciones @RestController y @RequestMapping de Spring.

¿Qué anotaciones usar para un controlador REST?

En el ecosistema de Spring, las anotaciones son esenciales para configurar y operar tus componentes. Para un controlador REST, las más relevantes son:

  • @RestController: Indica que la clase va a manejar peticiones REST.
  • @RequestMapping: Define la ruta que las distintas peticiones van a seguir.

¿Cómo crear un controlador REST paso a paso?

  1. Definir la clase del controlador: Inicia creando una nueva clase Java en el paquete de controladores.

    @RestController
    @RequestMapping("/products")
    public class ProductController {
        // Código del controlador
    }
    
  2. Inyectar el servicio necesario: Utiliza la anotación @Autowired para inyectar el servicio que gestionará los datos.

    @Autowired
    private ProductService productService;
    
  3. Implementar los métodos de la API: Define métodos en el controlador para cada operación de la API, utilizando el servicio inyectado. Aquí algunos ejemplos:

    public List<Product> getAll() {
        return productService.getAll();
    }
    
    public Optional<Product> getProduct(int productId) {
        return productService.getProduct(productId);
    }
    
    public Product save(Product product) {
        return productService.save(product);
    }
    
    public boolean delete(int productId) {
        return productService.delete(productId);
    }
    

¿Cómo verificar que el controlador está funcionando?

Una vez que el controlador esté configurado, el siguiente paso es lanzar la aplicación y verificar que se ejecute correctamente:

  1. Ejecutar el proyecto: Usa el comando Run para compilar y lanzar la aplicación de Spring Boot.
  2. Solucionar problemas comunes: Si encuentras el error "el puerto 8090 ya está en uso", significa que otro proceso está usando este puerto. Soluciona cerrando el proceso conflictivo.

¿Qué hacer si no se encuentra un recurso al acceder a la API?

Si al ingresar a una ruta específica en la API aparece un mensaje de error indicando que no encontró ningún recurso, es probable que los métodos del controlador no estén bien configurados para manejar las peticiones. La solución consiste en asegurarse de que cada método está correctamente "decorado" con anotaciones adecuadas en clases posteriores.

Recuerda, cada paso en el desarrollo con Spring es crucial para garantizar que tu aplicación sea robusta y funcional. Continúa explorando las anotaciones adicionales en Spring para exponer tus métodos a diferentes tipos de peticiones y sigue aprendiendo para perfeccionar tus habilidades en desarrollo de APIs.