Desarrollo de una API REST con Slim Framework y MySQL

Para instalar XAMPP, se debe descargar el instalador desde la página web oficial XAMPP. Se elegirá la versión para el sistema operativo en el que se vaya a realizar la instalación y basta con seguir las instrucciones de instalación. Por ejemplo, para la instalación en Windows, se puede descargar la última versión del instalador y ejecutarlo. Durante la instalación, se pueden seleccionar los componentes que se desean instalar, como Apache, MySQL, PHP y PHPMyAdmin. En nuestro caso, necesitaremos instalar Apache, MySQL, PHP y PHPMyAdmin.

Tras la instalación, se deberá ejecutar el panel de control de XAMPP y activar los servicios de Apache y MySQL. Para ello, se deberá abrir el panel de control de XAMPP y hacer clic en los botones Start de Apache y MySQL. Si los servicios se han iniciado correctamente, se mostrará un mensaje indicando que los servicios se han iniciado correctamente.

Composer es un administrador de dependencias para PHP que facilita la gestión de las dependencias de un proyecto PHP. Composer permite instalar y actualizar bibliotecas de terceros, así como gestionar las dependencias de un proyecto PHP de forma sencilla. Composer utiliza un archivo composer.json para definir las dependencias de un proyecto y un archivo composer.lock para bloquear las versiones de las dependencias. Composer se instala a nivel de sistema y se puede utilizar en cualquier proyecto PHP. En nuestro caso usaremos Composer para instalar Slim Framework, un microframework PHP para el desarrollo de APIs RESTful.

Para instalar Composer, se deberá descargar el instalador desde la página web oficial Composer. Se puede descargar el instalador para Windows y ejecutarlo. Durante la instalación, se seguirán las opciones predeterminadas y se instalará en una carpeta independiente de XAMPP (p.e. C:\composer). Tras la instalación, se deberá abrir una terminal y ejecutar el comando composer para comprobar que Composer se ha instalado correctamente. Si Composer se ha instalado correctamente, se mostrará un mensaje con la versión de Composer y los comandos disponibles, como se muestra a continuación:

Existen varias herramientas que permiten a los desarrolladores probar y depurar APIs. Algunas de las herramientas más populares son:

Slim es un microframework PHP que permite crear aplicaciones web rápidas y sencillas. En nuestro caso lo usaremos para crear una API REST que permita la comunicación entre el frontend y la base de datos. Antes tendremos que realizar una configuración en el servidor Apache para que pueda interpretar las rutas de Slim.

Un archivo en PHP puede contener código PHP y código HTML. El código PHP se encierra entre las etiquetas <?php y ?>, y el código HTML se escribe fuera de estas etiquetas. Al ser PHP un lenguaje interpretado, se ejecutará secuencialmente, línea por línea, y se mostrará el resultado en el navegador. Además, al poder intercalarse código PHP y HTML, se pueden realizar operaciones en PHP y mostrar el resultado en el navegador.

En cuanto a la sintaxis, destacar los siguiente:

A continuación se muestran algunos ejemplos de operaciones básicas en PHP:

La figura siguiente muestra el resultado de ejecutar el código PHP anterior en un navegador web.

El control de flujo en PHP se realiza mediante estructuras de control como if, else, elseif, while, do-while, for, foreach, switch, etc. Estas estructuras de control permiten controlar el flujo de ejecución del programa en función de ciertas condiciones. A continuación se muestran algunos ejemplos de control de flujo en PHP:

La figura siguiente muestra el resultado de ejecutar el código PHP anterior en un navegador web.

Las funciones en PHP permiten encapsular un bloque de código que puede ser reutilizado en diferentes partes del programa. Las funciones pueden recibir parámetros y devolver valores. A continuación se muestran algunos ejemplos de funciones en PHP:

La figura siguiente muestra el resultado de ejecutar el código PHP anterior en un navegador web.

Las funciones de devolución de llamada o funciones de callback son funciones que se pasan como argumentos a otras funciones y se ejecutan en un momento posterior. Las funciones de callback son útiles para manejar eventos asíncronos, como métodos de una API, o para aplicar una función a cada elemento de un array. A continuación se muestran algunos ejemplos de funciones de callback en PHP:

La figura siguiente muestra el resultado de ejecutar el código PHP anterior en un navegador web.

Los arrays en PHP son estructuras de datos que permiten almacenar múltiples valores en una sola variable. Los arrays pueden ser indexados numéricamente o asociativos, a los que se accede mediante un índice o una clave. Los arrays indexados numéricamente utilizan índices numéricos para acceder a los elementos, mientras que los arrays asociativos utilizan claves. Los arrays en PHP son dinámicos, lo que significa que pueden cambiar de tamaño durante la ejecución del programa. Además, los arrays en PHP pueden contener diferentes tipos de datos, como enteros, cadenas, booleanos, etc. A continuación se muestran algunos ejemplos de uso de arrays en PHP:

La figura siguiente muestra el resultado de ejecutar el código PHP anterior en un navegador web.

PHP ofrece una gran cantidad de funciones para el manejo de arrays, como count, array_push, array_pop, array_shift, array_unshift, array_slice, array_splice, array_merge, array_keys, array_values, array_filter, array_search, etc. Estas funciones permiten añadir, eliminar, modificar y recorrer los elementos de un array de forma sencilla y eficiente. Veamos un ejemplo de uso de algunas de estas funciones:

Los formularios son una parte fundamental de las aplicaciones web, ya que permiten a los usuarios introducir datos que serán enviados al servidor para su procesamiento. En PHP, los datos de un formulario se envían al servidor a través del método POST o GET. El método POST envía los datos al servidor de forma no visible, mientras que el método GET envía los datos al servidor a través de la URL. En general, se utiliza el método POST para enviar datos sensibles, como contraseñas, y el método GET para enviar datos no sensibles. No obstante, ya veremos más adelante que el método POST es el más utilizado para enviar datos a una API RESTful, como en la petición de creación de un nuevo recurso. A continuación se muestra un ejemplo de URL que envía datos a través del método GET:

En este caso se envían los datos nombre=María y edad=25 al archivo procesar.php a través del método GET. En PHP, los datos enviados a través del método GET se almacenan en un array asociativo llamado $GET. Por ejemplo, para acceder al valor del parámetro nombre, se puede utilizar $_GET['nombre']. nombre y edad son lo que se conoce como parámetros de consulta (_query params) y se envían al servidor a través de la URL. Los parámetros de consulta son pares clave-valor que se envían al servidor a través de la URL y se utilizan para enviar datos al servidor. En este caso los parámetros de consulta son nombre y edad, y sus valores son María y 25, respectivamente.

A continuación se muestra un ejemplo de un formulario HTML que envía datos a través del método POST. El formulario contiene dos campos, uno para el nombre y otro para la edad. Llamaremos a este formulario formulario.html. Este formulario enviará los datos al archivo procesar.php a través del método POST.

En este caso los datos del formulario se envían al archivo procesar.php a través del método POST. En PHP, los datos enviados a través del método POST se almacenan en un array asociativo llamado $_POST. Por ejemplo, para acceder al valor del parámetro nombre, se puede utilizar $_POST['nombre'].

A continuación se muestra un ejemplo de cómo procesar los datos enviados por el formulario en PHP. Llamaremos a este archivo procesar.php.

En este ejemplo se accede a los datos del formulario a través del array $_POST y se muestran en el navegador utilizando la función echo.

La figura siguiente ilustra a la izquierda el formulario y a la derecha el resultado de procesar los datos del formulario tras enviarlo.

Una API REST (Representational State Transfer) es un tipo de API que sigue los principios de la arquitectura REST. REST es un estilo de arquitectura que utiliza HTTP para realizar operaciones CRUD (Create, Read, Update, Delete) en recursos. En nuestro caso, los recursos normalmente serán tablas de una base de datos. Las APIs RESTful son diseñadas para ser simples, escalables y eficientes, utilizando métodos HTTP estándar y formatos de intercambio de datos como JSON y XML.

La principal diferencia entre una API y una API REST es que las APIs RESTful siguen los principios de la arquitectura REST, mientras que otras APIs pueden no seguir estos principios. Las APIs RESTful utilizan métodos HTTP estándar (GET, POST, PUT, DELETE) para realizar operaciones en recursos y utilizan URLs para identificar recursos específicos.

La figura siguiente ilustra las peticiones a una API RESTful utilizando los métodos HTTP estándar GET, POST, PUT y DELETE. Estas peticiones son enviadas a través de URLs que identifican los recursos específicos. Al ser recibidas por la API RESTful, se procesan (interactuando con la base de datos) y se envían las respuestas correspondientes.

Los métodos HTTP son utilizados para realizar operaciones en recursos en una API RESTful. Los métodos más comunes y sus principales usos son:

Cada uno de estos métodos tiene un propósito específico y se utiliza en diferentes situaciones para interactuar con los recursos de una API. Desde el punto de vista de bases de datos, cada uno lo podríamos hacer corresponder con una operación básica de SQL CRUD:

Los formatos de intercambio de datos son utilizados para representar la información que se envía y recibe a través de una API. Los dos formatos más comunes son JSON (JavaScript Object Notation) y XML (eXtensible Markup Language).

Los endpoints de una API son las URLs a las que se envían las solicitudes para interactuar con los recursos de la API. Cada endpoint representa una operación específica que se puede realizar en un recurso. Como ejemplos de endpoints, se pueden mencionar:

A continuación se explican algunos aspectos importantes sobre cómo especificar los endpoints de una API.

Las cabeceras HTTP son utilizadas para proporcionar información adicional sobre la solicitud o la respuesta. Algunas de las cabeceras más comunes son:

Las cabeceras son importantes para asegurar que la solicitud y la respuesta sean interpretadas correctamente por el cliente y el servidor.

Para inicializar el proyecto, se deben seguir los siguientes pasos:

Para realizar un aprendizaje progresivo de Slim, se comenzará con una API REST básica que permita realizar operaciones CRUD en una lista de productos, pero sin interactuar con una base de datos. Esto nos permitirá familiarizarnos con Slim y los conceptos básicos de una API RESTful, como los métodos HTTP, los endpoints, los formatos de intercambio de datos, el uso de cabeceras y parámetros, etc. En este caso se simulará una base de datos utilizando un array de productos en memoria. Tal y como comentamos anteriormente, la API tendrá los siguientes endpoints:

A continuación se detallan los pasos a seguir para crear esta API.

Comenzaremos creando un archivo index.php en la carpeta public con el siguiente contenido:

En este bloque de código, se crea la aplicación Slim y se configura la ruta base de la API. También se añade un middleware para procesar datos JSON en las solicitudes.

Creamos una función auxiliar para manejar las respuestas en formato JSON:

Esta función toma una respuesta (para devolver el contenido de las llamadas a la API) y un array de datos, establece el tipo de contenido a JSON, escribe los datos en el cuerpo de la respuesta y devuelve la respuesta.

A modo de ejemplo, ya que no tenemos una base de datos, definimos una lista global de productos que utilizaremos en los endpoints:

Este array asociativo simula una base de datos de productos para los propósitos de este tutorial.

Para hacer la primera prueba en la API, comenzaremos creando un endpoint básico que devuelva un mensaje. Se trata de que responda con un JSON sencillo cuando se invoque la URL base de la API (/). En este caso definimos un endpoint básico que devuelve un mensaje (código del ejemplo):

Este endpoint responde a las solicitudes GET en la ruta base (/) con un mensaje JSON. La figura siguiente muestra el resultado de acceder al endpoint básico desde Postman.

Ahora comenzamos a desarrollar ya realmente lo que son los endpoints de una API RESTful. Comenzamos con un endpoint que devuelve una lista de productos. Inicialmente, se devolverá la lista completa de productos. Posteriormente, se mejorará el endpoint para permitir filtrar los productos por nombre. Definimos inicialmente el endpoint que devuelve una lista de productos. El endpoint responde a las solicitudes GET en la ruta /product y devuelve la lista completa de productos (código del ejemplo)

La figura siguiente muestra el resultado de acceder al endpoint que devuelve una lista de productos en Postman.

Continuamos con el desarrollo de la API añadiendo un endpoint que devuelve un producto específico por ID. El endpoint responde a las solicitudes GET en la ruta /product/{id} y devuelve el producto con el ID especificado. El ID especificado en la ruta se obtiene mediante el array $args, un array asociativo que contiene los parámetros de la URL. A continuación se muestra cómo se puede hacer esto (código del ejemplo):

La figura siguiente muestra el resultado de acceder al endpoint que devuelve un producto específico por ID en Postman.

Continuamos con el desarrollo de la API añadiendo un endpoint que crea un nuevo producto. Normalmente, la creación de recursos en una API REST se realiza mediante solicitudes POST dirigidas al endpoint raíz del recurso. En este caso el endpoint responde a las solicitudes POST en la ruta /product. Además, la solicitud no incorpora un identificador en la URL, ya que el identificador se generará automáticamente por el servidor. Lo que sí lleva la solicitud son los datos del producto a crear, que se envían en el cuerpo de la solicitud. El servidor recibe la solicitud y crea un nuevo producto con los datos proporcionados en el cuerpo de la solicitud. Como respuesta, lo habitual es devolver el producto creado y un código de estado 201 Created. (Por motivos didácticos la respuesta aquí también incluye la lista completa de productos.) A continuación se muestra cómo se puede hacer esto (código del ejemplo):

La figura siguiente muestra el resultado de acceder al endpoint que crea un nuevo producto en Postman.

Continuamos con el desarrollo de la API añadiendo un endpoint que actualiza un producto existente. Normalmente, la actualización de recursos en una API REST se realiza mediante solicitudes PUT dirigidas a un endpoint específico del recurso indicando el ID del recurso a actualizar. En este caso el endpoint responde a las solicitudes PUT en la ruta /product/{id} y actualiza el producto con el ID especificado con los datos proporcionados en el cuerpo de la solicitud. El servidor recibe la solicitud, busca el producto por ID, actualiza los datos del producto con los datos proporcionados en el cuerpo de la solicitud y devuelve el producto actualizado con un código de estado 200 OK. (Por motivos didácticos la respuesta aquí también incluye la lista completa de productos.) A continuación se muestra cómo se puede hacer esto (código del ejemplo):

La figura siguiente muestra el resultado de acceder al endpoint que actualiza un producto existente en Postman.

Continuamos con el desarrollo de la API añadiendo un endpoint que elimina un producto. Normalmente, la eliminación de recursos en una API REST se realiza mediante solicitudes DELETE dirigidas a un endpoint específico del recurso indicando el ID del recurso a eliminar. En este caso el endpoint responde a las solicitudes DELETE en la ruta /product/{id} y elimina el producto con el ID especificado. El servidor recibe la solicitud, busca el producto por ID, elimina el producto y devuelve un mensaje con un código de estado 200 OK si el producto se ha eliminado correctamente o un código de estado 204 No Content si el producto no se ha encontrado. (Por motivos didácticos la respuesta aquí también incluye la lista completa de productos.) A continuación se muestra cómo se puede hacer esto (código del ejemplo):

La figura siguiente muestra el resultado de acceder al endpoint que elimina un producto en Postman.

En Slim, se puede interceptar las peticiones a endpoints inexistentes utilizando un middleware que se ejecuta después de que se hayan procesado todas las rutas. En este caso interceptaremos las peticiones a endpoints inexistentes y devolveremos un mensaje de error con un código de estado 404 Not Found. A continuación se muestra cómo se puede hacer esto (código del ejemplo):

La figura siguiente muestra el resultado de acceder a un endpoint inexistente en Postman.

Finalmente, ejecutamos la aplicación:

Este comando inicia la aplicación Slim y la pone en funcionamiento.

Ahora se pueden probar los endpoints de la API en un navegador o con una herramienta como Postman. La figuras anteriores muestran el resultado de acceder a los diferentes endpoints de la API en Postman.

Para interactuar con una base de datos MySQL en PHP, utilizaremos la extensión mysqli. mysqli es una extensión de PHP que proporciona una interfaz para interactuar con bases de datos MySQL. Permite realizar operaciones CRUD (Create, Read, Update, Delete) en la base de datos y manejar errores de forma eficiente. A continuación se detallan los pasos a seguir para interactuar con una base de datos MySQL utilizando mysqli y se muestran los objetos y métodos más comunes para realizar operaciones en la base de datos.

Una vez que conocemos los principales objetos y métodos de la extensión mysqli para interactuar con una base de datos MySQL, y cómo evitar la inyección de SQL, vamos a configurar la base de datos para la API REST con Slim y MySQL. A continuación se detallan los pasos a seguir para configurar la base de datos (sample_api.sql):

Para facilitar el desarrollo y el mantenimiento del proyecto se recomienda seguir una estructura en la que estén separados los bloques de código de los modelos, controladores y rutas. Los modelos son responsables de interactuar con la base de datos y definir la estructura de los datos. Los controladores son responsables de manejar la lógica de negocio y las rutas son responsables de definir las URL y los métodos HTTP que se utilizarán para acceder a los recursos.

Organizaremos el código principalmente de esta forma: en la carpeta raíz dejaremos los archivos de configuración y conexión a la base de datos. En la raíz habrá una carpeta src que contendrá el código de la API con los controladores, modelos, rutas y funciones auxiliares, todos ellos organizados en carpetas. En la raíz también habrá otra carpeta public que contendrá el archivo index.php y los archivos estáticos (CSS, JavaScript, imágenes, etc.). La estructura del proyecto quedará de la siguiente manera:

Este apartado lo vamos a dividir en dos. El primero está dedicado a configurar las bases de la API, como son archivos de configuración, conexión a la base de datos, estructura del proyecto y endpoints básicos. En el segundo se desarrollará la API REST con Slim y MySQL.

Una vez que hemos desarrollado la API REST con Slim Framework, podemos probar los endpoints utilizando Postman. A continuación se detallan los pasos a seguir para probar la API REST:

A continuación se muestran algunos ejemplos de peticiones a la API REST:

En estos ejemplos, se han probado las operaciones CRUD en la lista de productos utilizando la API REST con Slim y MySQL. Se han obtenido todos los productos, se ha obtenido un producto por ID, se ha creado un nuevo producto, se ha actualizado un producto existente y se ha eliminado un producto. Las operaciones CRUD se han realizado con éxito y se han devuelto los resultados esperados.