json

Si no ves el video, puedes refrescar el navegador, presionando (Ctrl+Shift+R | Ctrl+F5 o Shift+F5), o abrirlo directamente desde el Canal de Youtube... HAZ CLIC AQUI

      Siempre que trabajemos con proyectos en los que tengamos que testear la funcionalidad de API Rest, es recomendable que utilicemos las herramientas que facilitarán nuestras tareas de testeo, de manera que resulte más simple, el proceso de identificación de posibles errores, aplicar nuevas funcionalidades o crear documentación relacionada con el proceso.

     En nuestro caso, como estaremos trabajando con servicios del tipo REST en Drupal, vamos a tener que realizar varias comprobaciones, sobre las llamadas hacia nuestra API, utilizando GET, POST, PATCH y DELETE, con los cuales obtendremos información desde Drupal, como hemos explicado en el artículo anterior, Cómo trabajar con Rest en Drupal 9 (Parte 1), además de realizar otras operaciones como Añadir, Actualizar o borrar contenidos, por medio de estos métodos.

     En las siguientes líneas trataré de explicar, de la manera resumida, los principios fundamentales para entender, cómo aplicar llamadas a la API Rest que nos permitan la ejecución de las principales operaciones, al emplear esta clase de sistema, con Drupal 9.

     Una de estas herramientas de desarrollo es Postman, que nos ofrece una interfaz gráfica, en la que podremos realizar varios tipos de operaciones relacionadas con API Rest, para facilitarnos el proceso de testeo para nuestros proyectos. Puedes descargar Postman desde su página oficial.

     Ahora que ya hemos configurado los servicios dentro de Drupal, para autorizar las consultas, mediante el uso de GET, y obtener así el contenido de varios nodos, vamos a realizar la misma comprobación ejecutando la llamada en Postaman, para ello, una vez descargada la aplicación Postman,  copiaremos la url o "endpoint", que nos devolverá el listado de los nodos de nuestra página de inicio, tal y como los expliqué en el artículo anterior Cómo trabajar con Rest en Drupal 9 (Parte 1), y deberíamos obtener exactamente el mismo resultado.

    Métodos de autenticación:

          Cuando realizamos llamadas a un API Rest, necesitaremos al menos un método de autenticación, de esa forma, estaremos diciéndole a nuestra aplicación, que tenemos los permisos necesarios para acceder a la información con la que vamos a trabajar.

          Existen varias formas de autenticarnos, a la hora de trabajar con las llamadas al API REST, una de ellas, es el uso de cookies; y aunque generalmente, el uso del método Get para obtener información mediante API REST, no debería necesitar ningún tipo de autenticación, ya que sólo estamos accediendo a información pública, expuesta a cualquier usuario desde nuestro servidor web, al trabajar con los servicios REST en Drupal, nos exige que al menos activemos un método de autenticación.

         Es por esta razón, por la cual lo hicimos en el artículo anterior, al momento de activar nuestro primer servicio con el Método Get, para leer la información sobre los nodos desde nuestro Drupal.

          Por defecto, Drupal utiliza el sistema de Cookies para informarse sobre los datos de nuestro usuario, es por esta razón que al loguearnos en cualquier web de Drupal, la interfaz nos permitirá ver los contenidos para los que tengamos acceso, si somos los administradores, veremos la interfaz del administrador y si somos usuarios de cualquier otro tipo, nos presentará la interfaz de usuario correspondiente.

          Si quieres comprobar las cookies que genera Drupal automáticamente cuando estás logueado como usuario, puedes hacer clic derecho y seleccionar inspeccionar elemento o presionar la tecla F12, en mi caso utilizo Google Chorme, si tu también lo hacer, deberías ver algo como lo que te presento en la siguiente imagen, He seleccionado la pestaña Network y tengo marcada la opción Preserve log, al hacer clic sobre Headers verás la información que estamos enviando a nuestro servidor, donde está alojada la web de Drupal y dentro de estas informaciones podrás comprobar la existencia de las cookies.

          Aunque el uso de Cookies es un método que funciona para que Drupal nos devuelva información, en el caso de una aplicación externa, ubicada en otro servidor, por ejemplo, que quisiera obtener información mediante API REST, necesitaremos un método de autenticación más robusto, porque para Drupal, como cualquier otra aplicación a la que accedamos por servicios web, quien acceda usando este tipo de autenticación, podrá operar con todos los permisos concedidos para ese usuario.

         Otra forma de identificarnos como usuario con permisos frente a Drupal, utilizando API REST, es el uso del TOKEN DE SESIÓN, con el que le diremos a Drupal todo lo que necesita saber acerca de nuestro usuario, para que pueda ofrecernos lo que vamos a necesitar al conectarnos con él.

         Hasta las primeras versiones de Drupal 8, para obtener el TOKEN DE SESIÓN, bastaba con añadir a la url de nuestra web, una vez activado el módulo rest "http//miweb.com/rest/session/token", esto nos imprimía en la pantalla el valor correspondiente, que tendríamos que copiar dentro de los parámetros de configuración, para nuestra API rest.

         Esta opción fue eliminada a partir de las últimas actualizaciones de Drupal 8, por lo que ya no existe en Drupal 9 ni versiones posteriores. En su lugar se añadió un módulo contribuido llamado REST API Access Token, con el cual, según la página oficial:

     "El módulo REST API Access Token proporciona un proveedor de autenticación Drupal que utiliza tokens (en encabezados) como factor principal de autenticación.
Además, el módulo proporciona verificación de firmas para solicitudes y caché de respuestas."

        Necesitaremos descargar e instalar este módulo, para realizar las pruebas con las llamadas a la API REST, cuando trabajemos con los métodos POST, PATCH y DELETE, que explicaremos en el siguiente artículo, pero antes de terminar, vamos a hablar de una última herramienta que necesitaremos para testear nuestros servicios web...     

     CURL

          Según la página oficial de PHP: PHP soporta libcurl, una biblioteca creada por Daniel Stenberg que permite conectarse y comunicarse con diferentes tipos de servidores y diferentes tipos de protocolos. Actualmente, libcurl admite los protocolos http, https, ftp, gopher, telnet, dict, file y ldap. libcurl también admite certificados HTTPS, HTTP, POST, HTTP PUT, subidas mediante FTP (también se puede hacer con la extensión FTP de PHP), subidas basadas en formularios HTTP, proxies, cookies, y autenticación usuario+contraseña.

         Dependiendo del sistema operativo con el que estés trabajando, y de la versión de PHP que tengas instalada, la manera en que se configura CURL variará, por lo tanto, sería recomendable que compruebes si la tienes configurada correctamente en tu servidor antes de comenzar con la siguiente fase de estos ejercicios.

    Cómo comprobar si tengo instalado CURL en Drupal 9

          En todas las instalaciones de Drupal, podremos acceder a una página que nos detallará las informaciones principales, relacionadas con las informaciones más relevantes sobre nuestro servidor, Mysql, Php, además de otras relacionadas directamente con la configuración interna de Drupal. 

          Obviamente, para acceder a estos datos necesitarás tener permisos de administrador, y estar logueado dentro de tu web. La url es "/admin/reports/status". Una vez hayas accedido a esta pantalla, podrás hacer clic en el apartado MAS INFORMACIÓN de PHP, donde podrás ver el phpinfo, y comfirmar si ya tienes habilitada esta librería en tu entorno.

Si no ves el video, puedes refrescar el navegador, presionando (Ctrl+Shift+R | Ctrl+F5 o Shift+F5), o abrirlo directamente desde el Canal de Youtube... HAZ CLIC AQUI

      Siguiendo con las opciones disponibles para combinar, el uso de Drupal como Backend, con librerías JavaScript del tipo Vue.js o Angular, para el Frontend; hoy abordaré los principios básicos sobre recursos Rest en Drupal 9, para que puedas comenzar a experimentar.

     A partir de su versión 8, se añadieron varios módulos en el núcleo de Drupal, con el fin de facilitarnos la activación de los más utilizados, como es el caso de los servicios web, ya que es cada vez más frecuente, encontrarnos con proyectos, que requieren conectar un sistema robusto de gestión como ofrece Drupal, con aplicaciones para móviles o simplemente, para añadir una presentación de contenidos más flexible, atractiva y amigable de cara a los usuarios finales.

     Con el módulo Rest entre otras opciones, podremos generar, de forma sencilla, todo tipo de contenidos e información en formato Json o XML, además de configurar accesos, para la gestión de usuarios y contenidos a través del uso de APIs, desde prácticamente cualquier tipo de aplicación disponible.

Requisitos:

     - Tener una web Drupal en funcionamiento, con varios contenidos preferiblemente con taxonomías, imágenes, textos y usuarios creados, para que puedas realizar diferentes pruebas.

     Si no tienes contenidos, o prefieres generar contenido de prueba, para realizar tus configuraciones, puedes utilizar el módulo Devel Generate, integrado en el módulo Devel, con el cual podrás generar todo el contenido que necesites basándote en los tipos de contenido que prefieras, haciendo únicamente un par de clics.

     Aquí tienes la explicación de Cómo generar contenidos de Prueba con el módulo Devel

     - Descargar y activar el módulo Rest UI, para facilitar la gestión de los endpoints y accesos utilizando la interfaz de Drupal. Aunque en la página oficial de módulo sólo especifica que es compatible para la versión 8, si lo descargas usando Composer podrás utilizarlo en tu Drupal 9.

Cómo trabajar con Rest en Drupal 9  

     Paso 1 Activación de módulos RESTfull Web Services y Serialization:

          Con la activación y combinación de estos módulos, incluidos en el núcleo de Drupal, a partir de la versión 8, podremos, entre otras cosas, crear nuevas vistas, que nos mostrarán el contenido en formato Json o también podremos añadir vistas de este tipo a otras ya existentes.

          Además de esto módulos, antes de continuar, aprovecharemos para descargar y activar el módulo REST UI que mencionamos en los requisitos, para realizar configuraciones relacionadas con REST, a través de la interfaz de usuario de Drupal.

     Paso 2 Descarga y activación del módulo REST UI:

          Descarga y Activación REST UI:

               Para descargar y activar cualquier módulo de Drupal tienes varias opciones:

     Descarga:

          1.- La forma recomendada a partir de Drupal 8, es utilizando el gestor de paquetes Composer, ejecutando en tu consola el comando:

composer require drupal/restui

 

          2.- Descargándolo manualmente el módulo desde la página oficial del Módulo Rest UI  y una vez descargado y colocado en carpeta "modules/contrib", si haz descargado todos tus módulos manualmente, deberías crear la carpeta "contrib", para que puedas diferenciar entre tus módulos personalizados y los que están disponibles directamente en la Página oficial de Drupal.

     Activación:

          1.- Utilizando la herramienta de consola Drush, la opción "-y" activará todos los sub-modulos automáticamente.

drush en restui -y

          2.- Desde la interfaz de usuario de Drupal, en la url "/admin/modules", y luego marcando el check junto al nombre de tu módulo y haciendo clic en el botón guardar que aparecer al final de la página.

     Paso 3 Creación y configuración de una vista en formato Json:

          La primera novedad que podremos comprobar, una vez activados los módulos RESTful Web Services y Serialization, es que si nos vamos a la pantalla para la creación de vistas, en la url "/admin/structure/views/add" y seleccionamos Agregar vista, podremos ver en la parte inferior una nueva opción, llamada Configuración de exportación REST.

         Si seleccionamos esta opción, nos creará una vista en la que podremos mostrar los datos en formato json o xml.

 

     Vamos a comenzar con la creación de una vista tipo REST, en la que mostraremos el listado de artículos, para este ejercicio puedes utilizar el módulo Devel Generate, para crear contenidos de prueba con un par de clics, o si lo prefieres, crear algunos artículos manualmente.

     Una vez tengas los artículos que vas a mostrar en tu vista, puedes aplicar la misma configuración que te muestro en la siguiente imagen, con estas opciones seleccionadas, haremos clic en el botón Guardar y editar, para que se nos abra la pantalla de configuración donde terminaremos de realizar los ajustes necesarios para obtener nuestro objetivo.

     Una vez que estemos dentro de la pantalla de configuración de nuestra vista, el primer cambio que deberíamos realizar es modificar la configuración para que el contenido de la vista se muestre en formato json.

     Para ello, primero haremos clic en configuración, dentro del apartado FORMATO, tal y como te muestro en pantalla:

     A continuación, para este ejercicio, seleccionaremos el formato json y una vez hayamos aplicado el cambio, inmediatamente podremos ver cómo se muestran nuestros artículos en formato json, dentro de nuestra v

     Para este ejemplo hemos creado un sólo artículo, pero nuestra vista muestra un montón de información, debido a que en el FORMATO, está marcada la opción de Mostrar: Entidad, lo que significa que mostrará mucho más de lo que necesitaríamos para realizar consultas y conexión con alguna aplicación.

     Una consulta como esta consumiría una gran cantidad de recursos para su ejecución, por lo que se verían afectados el tiempo de respuesta y por lo tanto el resultado final de nuestro desarrollo.

     Para evitar que Drupal nos devuelva información innecesaria por ahora, cambiaremos la opción del Formato, para obtener sólo algunos campos, en lugar de toda la entidad; para nuestro ejemplo, seleccionaremos el título, el autor y la fecha de creación. 

     Una vez añadidos los campos, el resultado final es un listado mucho más sencillo y fácil de leer y manipular:

     Paso 4 Comprobación de la vista en el navegador:

          Para comprobar que nuestra vista en formato Json funciona correctamente, tendremos que acceder con la url que hemos configurado al crearla y el resultado debería ser el mismo que hemos visto en la pantalla de configuración, en mi caso he añadido la extensión de Chorme llamada JSON Viewer:

     Cómo mostrar contenidos de Drupal, en formato json, sin tener que configurar una vista

           Ya conocemos la manera de generar vistas para obtener resultados en formato Json, pero además, podremos acceder directamente a un contenido en concreto, también en formato json, añadiendo a la url de nuestra web, las especificaciones del formato requerido. 

          Por ejemplo, podremos acceder a nuestro artículo 1, o node/1 para que se nos muestre en formato json, añadiendo al final de la url las especificaciones del formato.

          En nuestro caso, sería algo como esto http://drupal9.localhost/node/1?_format=json, si hacemos la prueba en el navegador nos devolverá algo parecido a la siguiente imagen:

 

          Si hemos obtenido este resultado, es debido a que todavía nos falta indicarle a Drupal, que nos permita acceder de esta forma. Para lograrlo tendremos que habilitar los recursos utilizando el módulo REST UI, Así que nos iremos a la url "/admin/config/services/rest" y dentro buscaremos y activaremos el recurso que nos permita acceder a los contenidos utilizando get, tal y como te muestro a continuación:

     Tan pronto como realicemos estos cambios, si volvemos a nuestro navegador y refrescamos, veremos un contenido similar al que mostrábamos en la vista.

     Cómo acceder a vistas ya existentes para que se muestren en formato Json

          Al igual que hemos hecho para acceder a los datos de un nodo, podríamos intentar realizar la misma operación llamando a una vista existente. Por ejemplo, a partir de Drupal 8, en el listado de las vistas, podremos encontrar una llamada frontpage, que nos muestra por defecto todos los contenidos que hayamos creado, sino hemos realizado ninguna otra configuración, para que se muestre otro tipo de página como inicio de nuestra web.

          Cómo vemos en la imagen, la url para esta vista frontpage es /node, por lo tanto, si queremos que nos devuelva sus contenidos en formato json, tendremos que añadir un modo de vista REST, desde la pantalla de configuración, luego le asignaremos una url, por ejemplo /node/rest y realizaremos los mismos cambios del formato que efectuamos en el primer ejemplo de este artículo.

 

          Cuando hayamos terminado la configuración de nuestra nueva vista, a la que accederemos por la url "node/rest", tendremos que habilitar el recurso, antes de poder escribir en el navegador "http://drupal9.localhost/node/rest?_format=json", ya que si lo hacemos, sin habilitar el recurso, nos devolverá un error al igual que nos sucedió al intentarlo con el nodo.

     Por lo tanto, si escribimos en el navegador las mismas especificaciones de formato que aplicamos, para acceder al node/1, deberíamos obtener la vista de nuestra página principal en formato Json.

     Pero, como habrás imaginado, al igual que hicimos con el recurso para acceder al nodo, tendremos que activar otro recurso para lograr este nuevo objetivo.

     Ahora que ya sabes cómo habilitar los recursos del módulo REST UI, para acceder a los contenidos, y obtener resultados en formato JSON, si escribes en el navegador, la url para mostrar tu vista "node/rest", con el formato especificado, entonces deberías ver algo parecido a la imagen siguiente, que será equivalente al contenido y campos que hayas configurado en tu vista.

     En este segundo ejemplo con vistas, he añadido el campo título y el campo body.

Si no ves el video, puedes refrescar el navegador, presionando (Ctrl+Shift+R | Ctrl+F5 o Shift+F5), o abrirlo directamente desde el Canal de Youtube... HAZ CLIC AQUI

      ¿Qué es un Servicio?

          Nuestras aplicaciones están llenas de objetos útiles. Un ejemplo de ello es el objeto "Mailer", cuya implementación está relacionada con la gestión de mensajería y correos electrónicos, o por ejemplo, otros objetos, que nos ayudarán con toda clase de operaciones, relacionadas con tablas y bases de datos.  En resumen, casi todo lo que podemos ejecutar dentro de nuestras aplicaciones, se hace posible a través del uso o implementación de estos objetos.        

          En Symfony, a estos objetos se les conoce como Servicios, y cada servicio, a su vez, habita dentro de un objeto especial llamado Service Container, o contenedor de servicios.

         Debido a que, a partir de la versión 8, el núcleo de Drupal está basado en Symfony, podremos acceder y utilizar estos servicios, además de la posibilidad de crearlos a medida, para implementarlos dentro de nuestros proyectos.

         El proceso de creación e implementación de un servicio en Drupal 9, es relativamente simple. Se trata de crear nuestra clase, dentro del módulo personalizado y a continuación, declararla como servicio para poder reutilizarla en cualquier parte del proyecto, mediante el método conocido como Injección de dependencias. Pero antes de ir más allá, vamos a concentrarnos en conocer los fundamentos relacionados con la creación e implementación de un servicio personalizado en Drupal 9.

     Cómo crear un servicio personalizado en Drupal 9  

          Paso 1 - Creación de módulo personalizado:

               Cómo hemos mencionado antes, lo primero que debemos hacer antes de la creación del servicio, es crear nuestro propio módulo personalizado; si todavía no sabes cómo hacerlo, te invito a que pares un momento, antes de continuar,  y eches un vistazo al artículo Cómo crear un módulo en Drupal 9, donde te explico paso a paso y con un video, cómo hacerlo.

name: Saludo Service
description: 'Create A service Example'
package: drupaladicto

type: module
core_version_requirement: ^8.8.0 || ^9.0

          Paso 2 - Creación de nuestro servicio personalizado:

              Ahora que ya tenemos nuestro módulo personalizado, vamos a proceder con la creación del servicio. Para este ejemplo, crearemos un servicio al que llamaremos , SaludoService.php y que nos devolverá, mediante el método getSaludo(), y de forma aleatoria, varias frases que solemos utilizar para saludar.

              Si quieres más información relacionada con la estructura de los servicios y otros datos relacionados, puedes visitar la Página Oficial de Drupal

              La clase deberá estar ubicada dentro de la carpeta src, tal y como te muestro en la siguiente imagen:

A continuación, copia y pega el código dentro de nuestra clase:              

<?php

namespace Drupal\saludo_service;

/**
 * @file
 * Service Example
 */

class SaludoService {

  private $saludo;

  /**
   * Passing parameter to construct method
   */
  public function __construct(){

    $this->saludo = ['Hola','¿Qué tal estás?', 'Buenos Días!!'];

  }

  /**
   * @return string
   */
  public function getSaludo(){

    return $this->saludo[array_rand($this->saludo)];
  }

}

     Paso 3 - Declaración del servicio:

          Como comentábamos al principio de este artículo, los servicios se alojan dentro de un contenedor llamado Service Container, desde donde podrán ser llamados para utilizarlos dentro de cualquier lugar de la web mediante la Injección de Dependencias, para que nuestro servicio personalizado pueda cumplir con esta característica y por lo tanto, se incluido en este contenedor de servicios, tendremos que declararlo como tal, creando el archivo ".service.yml"., al mismo nivel que está nuestro ".info.yml"

          Dentro de este nuevo archivo, tendremos la estructura que te muestro a continuación, en la cual simplemente estamos declarando el servicio y a continuación, añadimos la ubicación de nuestro servicio. Recuerda respetar los espacios del formato "yml" o no funcionará. Además evita el uso de la tecla TAB para los espacios, en su lugar utiliza la barra espaciadora del teclado.

services:
  saludo_service.saludando:
    class: Drupal\saludo_service\SaludoService

     Paso 4 - Testeo del servicio utilizando un controlador:

          Aunque en versiones anteriores a Drupal 9, podíamos comprobar la ejecución de código PHP, directamente utilizando la interfaz de usuario, a la que se añadía esta opción cuando activábamos el modulo Devel, ésta fue eliminada del mismo, por motivos de seguridad. 

          Por esta razón, para poder comprobar nuestro servicio, en lugar de utilizar PHP Unit, utilizaremos un controlador, que nos permitirá crear una página test, donde podremos ver y comprobar el funcionamiento de nuestro servicio, una vez hayamos instalado y activado nuestro módulo personalizado.

          Para imprimir el contenido del servicio, crearemos una variable a la que asignaremos el método "getSaludo(); ", que hemos definido dentro de nuestro servicio y luego imprimiremos su valor utilizando la función ksm() del modulo Devel.

          Si todavía no sabes cómo crear un controlador en Drupal 9, te invito a que pares un momento antes de continuar y eches un vistazo a este artículo donde explico, con un video y su documentación paso a paso Cómo crear módulos con su Controlador y Plantilla en Drupal 9

          El siguiente código es el que deberá tener nuestra clase controlador SaludoServiceController.php para generar la página y posteriormente llamar al servicio e imprimir los resultados de prueba.

<?php

/**
 * @file
 * Implement hook_controller()
 */

namespace Drupal\saludo_service\Controller;

use Drupal\Core\Controller\ControllerBase;


class SaludoServiceController extends ControllerBase {


  public function content(){


    $miservicio = \Drupal::service('saludo_service.saludando');
    $misaludo = $miservicio->getSaludo();

    ksm($misaludo);

    return [
      '#markup' => $this->t('Hello @misaludo', ['@misaludo' => $misaludo ]),
    ];

  }
}

          Además, te dejo el código del archivo saludo_service.routing.yml, donde he definido la dirección a nuestro controlador y su método content para acceder a la página test.

saludo_service.saludopage:
  path: '/test-page'
  defaults:
    _controller: '\Drupal\saludo_service\Controller\SaludoServiceController::content'
  requirements:
    _permission: 'access content'

 

          Cuando hayas comprobado que no te falta ningún archivo, podrás activar el módulo y acceder a la url definida en el path del routing.yml "/testpage" y deberías ver el mismo resultado que te muestro a continuación.