Construyendo un RESTFul API con Symfony 2, Parte 2

En el post anterior, Building a RESTful API with Symfony 2, Part 1, explicamos cómo instalar y configurar los bundles necesarios para la creación de nuestro API REST con Symfony 2, detallando también la estructura de directorios de nuestra aplicación:

• ToDoExample/
  • backend/
  • frontend/

En esta segunda entrega, nos enfocaremos en el backend de nuestra aplicación, explicando paso a paso cómo configurar los métodos GET, POST, PUT, y DELETE para implementar el CRUD utilizando el bundle FOSRestBundle. Posteriormente, en la tercera entrega, abordaremos el desarrollo del frontend utilizando AngularJS para consumir los recursos de nuestro API REST.

Puedes acceder al contenido completo de la primera parte y de este post en el siguiente enlace: GitHub - Symfony API REST Example.

Estructura de la Aplicación

Como se mencionó anteriormente, seguimos los pasos para la creación de una aplicación TO-DO que permitirá crear, editar, gestionar y eliminar tareas, con campos como título, descripción y estado. En la primera parte, creamos un nuevo bundle llamado TaskBundle. Ahora, debemos cargar dicho bundle en nuestro kernel de Symfony:

public function registerBundles() {
   $bundles = array(
       ...
       new FOS\RestBundle\FOSRestBundle(),
       new JMS\SerializerBundle\JMSSerializerBundle(),
       new Nelmio\CorsBundle\NelmioCorsBundle(),
       new Rootstack\TaskBundle\RootstackTaskBundle(),
       ...
   );
   ...
}

Configuración del Routing

Editaremos el archivo /app/config/routing.yml para configurar nuestro controlador REST y agregarle un prefijo a la ruta. Debemos sustituir este código:

rootstack_task:
   resource: "@RootstackTaskBundle/Controller/"
   type: annotation
   prefix: /

Por este:

rootstack_task:
   type: rest
   resource: "@RootstackTaskBundle/Controller/TaskController.php"
   prefix: /api

De esta manera, accederemos a nuestros recursos utilizando la URL base: http://localhost/ToDoExample/backend/app_dev.php/api/{ruta_para_cada_recurso}.

Configuración de la Base de Datos

Antes de comenzar a escribir el código, configuramos la base de datos:

1. Edita el archivo parameters.yml ubicado en ToDoExample/backend/app/config/:

parameters:
   database_host: localhost
   database_port: null
   database_name: rest_symfony
   database_user: [your_database]
   database_password: [your_password]

2. Ejecuta el siguiente comando para crear la base de datos:

$ php app/console doctrine:database:create
    

Generando la Entidad Task

Definimos los campos necesarios en nuestra entidad Task (título, descripción y estado). Así quedará nuestra entidad:

<?php
// Código de la entidad Task con métodos para obtener y establecer cada campo
?>

Después de definir la entidad, ejecuta el siguiente comando para crear el schema en la base de datos:

$ php app/console doctrine:schema:update --force
    

<?php
        // Código del formulario TaskType
        ?>
        

<?php
        // Código del controlador con métodos para gestionar tareas
        ?>
        

/**
        * Get a task by ID
        * @param Task $task
        * @return array
        * @ParamConverter("task", class="RootstackTaskBundle:Task")
        */
        public function getTaskAction(Task $task) {
           return array('task' => $task);
        }