En el mundo del desarrollo web, existen varias opciones para construir APIs que permiten la comunicaci\u00f3n entre aplicaciones. Dos de las opciones m\u00e1s populares son GraphQL y API REST. En esta exploraci\u00f3n, nos enfocaremos en API REST, una arquitectura ampliamente utilizada y muy poderosa.<\/p>\n\n\n\n
Definiendo endpoints para comunicaci\u00f3n<\/strong><\/p>\n\n\n\n Antes de profundizar en los detalles de API REST, es importante comprender qu\u00e9 es un \u00abendpoint\u00bb. En el contexto de las APIs, un \u00abendpoint\u00bb es una URL espec\u00edfica que nuestro servidor expone y que los clientes pueden utilizar para interactuar con la API. Cada endpoint representa una entidad o un recurso en el servidor, y puede realizar una operaci\u00f3n espec\u00edfica, como recuperar datos, crear nuevos recursos, actualizar informaci\u00f3n o eliminar recursos.<\/p>\n\n\n\n En una API REST, la comunicaci\u00f3n con el servidor se basa en los m\u00e9todos HTTP, como Por ejemplo, consideremos una API REST que maneja una lista de tareas. Podr\u00edamos tener los siguientes endpoints:<\/p>\n\n\n\n Cada uno de estos endpoints representa una acci\u00f3n espec\u00edfica que podemos realizar en la API REST. Al realizar una solicitud HTTP a un endpoint, el servidor ejecutar\u00e1 la acci\u00f3n correspondiente y responder\u00e1 con los datos solicitados o una confirmaci\u00f3n del cambio realizado.<\/p>\n\n\n\n Diferencia entre API y API REST<\/strong><\/p>\n\n\n\n Es importante destacar la diferencia entre API y API REST. Mientras que API (Interfaces de Programaci\u00f3n de Aplicaciones) es un t\u00e9rmino general que describe cualquier conjunto de definiciones y protocolos que permiten la comunicaci\u00f3n entre distintas aplicaciones, API REST es una arquitectura espec\u00edfica que utiliza el protocolo HTTP y sigue ciertas convenciones para manejar recursos.<\/p>\n\n\n\n Express<\/a> es un framework web minimalista y flexible para Node.js que permite construir aplicaciones web y APIs de manera r\u00e1pida y sencilla. Es una de las herramientas m\u00e1s populares y ampliamente utilizadas en el ecosistema de Node.js debido a su simplicidad y su enfoque en facilitar el desarrollo de aplicaciones backend.<\/p>\n\n\n\n Express proporciona una capa de abstracci\u00f3n sobre el manejo de solicitudes y respuestas HTTP, lo que facilita la creaci\u00f3n de rutas, manejo de par\u00e1metros, implementaci\u00f3n de middleware y configuraci\u00f3n de servidores. Adem\u00e1s, ofrece una amplia variedad de funcionalidades y m\u00f3dulos adicionales mediante su sistema de middleware, lo que permite extender las capacidades de la aplicaci\u00f3n seg\u00fan las necesidades espec\u00edficas del proyecto.<\/p>\n\n\n\n Hoy vamos a embarcarnos en un viaje por el maravilloso mundo de Express, un poderoso framework web para Node.js que nos permitir\u00e1 construir aplicaciones nuestras APIs de manera r\u00e1pida y sencilla.<\/p>\n\n\n\n Imagina a Express como un capit\u00e1n experimentado que nos ayuda a preparar nuestras velas (instalar y configurar Express) antes de zarpar en nuestro barco de desarrollo.<\/p>\n\n\n\n Antes de poder aprovechar todas las ventajas de Express, primero debemos instalarlo en nuestro proyecto. Esto se hace a trav\u00e9s de npm, el administrador de paquetes de Node.js. Ejecutamos el siguiente comando en la terminal para descargar Express y sus dependencias<\/p>\n\n\n\n Una vez que tenemos Express en nuestro proyecto, podemos configurar nuestra aplicaci\u00f3n. Crearemos una nueva aplicaci\u00f3n utilizando la funci\u00f3n express() y la asignaremos a la variable app. \u00a1Izamos las velas y estamos listos para zarpar!<\/p>\n\n\n\n Las rutas en Express son como un mapa que nos gu\u00eda en nuestro viaje. Cuando alguien nos pida un destino espec\u00edfico, sabremos qu\u00e9 camino tomar para llegar all\u00ed.<\/p>\n\n\n\n En Express, definimos rutas utilizando los m\u00e9todos HTTP como GET, POST, PUT, DELETE, entre otros como hemos visto en la definici\u00f3n de API Rerst. Cada m\u00e9todo corresponde a una acci\u00f3n que queremos realizar en nuestro servidor. Por ejemplo, cuando alguien solicita la p\u00e1gina de inicio (\u00ab\/\u00bb) de nuestro sitio web, responderemos utilizando el m\u00e9todo GET.<\/p>\n\n\n\n En nuestro viaje, nos encontramos con otros navegantes que nos hacen solicitudes y esperan nuestras respuestas. Express nos ayuda a comunicarnos con ellos de manera efectiva.<\/p>\n\n\n\n En Express, cuando alguien realiza una solicitud a nuestro servidor, la solicitud se captura como un objeto req (request) y la respuesta que enviaremos se prepara como un objeto res (response). Utilizamos estos objetos para interactuar con los navegantes y enviar contenido de vuelta al cliente.<\/p>\n\n\n\n El m\u00e9todo res.send() es una forma com\u00fan de enviar una respuesta al cliente. Puede enviar una cadena de texto, un objeto JSON, un archivo, entre otros. Por otro lado, el m\u00e9todo res.json() es espec\u00edficamente para enviar una respuesta en formato JSON.<\/p>\n\n\n\n <\/p>\n\n\n\n Es hora de encender nuestro programa y empezar a escuchar las solicitudes que recibimos para darles una respuesta<\/p>\n\n\n\n Para ello voy a utilizar un programa llamado Postman<\/a> que me permitir\u00e1 realizar request http al servidor que acabo de crear, en este caso har\u00e9 una llamada tipo GET<\/strong> a http:\/\/localhost:5050\/usuario<\/strong> <\/p>\n\n\n\n A trav\u00e9s del Postman simulo un la funcionalidad de Frontend solicitando datos a mi API<\/p>\n\n\n\n Responder los requests con un status code adecuado es una pr\u00e1ctica fundamental en el desarrollo de aplicaciones web y APIs. Los status codes son c\u00f3digos num\u00e9ricos enviados por el servidor como parte de la respuesta HTTP, y comunican el resultado del procesamiento de una solicitud realizada por el cliente. Estos c\u00f3digos proporcionan informaci\u00f3n esencial sobre el estado de la solicitud y permiten que el cliente y otros componentes comprendan c\u00f3mo se ha manejado su petici\u00f3n.<\/p>\n\n\n\n Aqu\u00ed hay una introducci\u00f3n sobre por qu\u00e9 es importante responder los requests con un status code adecuado:<\/p>\n\n\n\n 1. Comunicaci\u00f3n clara y consistente:<\/strong> Los status codes proporcionan una forma estandarizada de comunicaci\u00f3n entre el servidor y el cliente. Al utilizar c\u00f3digos bien definidos, se logra una comunicaci\u00f3n clara y consistente, lo que permite que los desarrolladores y las aplicaciones comprendan r\u00e1pidamente la naturaleza de la respuesta.<\/p>\n\n\n\n 2. Indicar el resultado de la solicitud:<\/strong> Los status codes describen el resultado de la solicitud de manera concisa. Pueden informar si la solicitud fue exitosa, si se redireccion\u00f3, si hubo un error del cliente o un error interno del servidor, entre otros escenarios posibles. Esto ayuda a los clientes a determinar si su petici\u00f3n tuvo \u00e9xito y c\u00f3mo deben interpretar la respuesta.<\/p>\n\n\n\n 3. Facilitar la depuraci\u00f3n y el manejo de errores:<\/strong> Cuando una solicitud no se procesa correctamente, los status codes permiten que el cliente y el servidor comprendan la causa del problema. Esto es fundamental para facilitar la depuraci\u00f3n y el manejo de errores. Los c\u00f3digos de estado espec\u00edficos ayudan a los desarrolladores a identificar r\u00e1pidamente qu\u00e9 sali\u00f3 mal y tomar las medidas necesarias para corregir el problema.<\/p>\n\n\n\n 4. Guiar el flujo de la aplicaci\u00f3n:<\/strong> Los status codes tambi\u00e9n se utilizan para guiar el flujo de la aplicaci\u00f3n o la API. Por ejemplo, un status code de redirecci\u00f3n (3xx) indica que la ubicaci\u00f3n del recurso solicitado ha cambiado temporal o permanentemente, lo que permite al cliente tomar la acci\u00f3n adecuada para acceder al recurso actualizado.<\/p>\n\n\n\n 5. Mejorar la experiencia del usuario:<\/strong> Al responder con c\u00f3digos de estado adecuados, se mejora la experiencia del usuario. Los mensajes de error claros y precisos permiten a los clientes comprender lo que sucedi\u00f3 y c\u00f3mo pueden resolver el problema, lo que evita confusiones y frustraciones innecesarias.<\/p>\n\n\n\n Aqu\u00ed te dejo una lista de los status code m\u00e1s comunes<\/p>\n\n\n\n Respuestas exitosas (2xx):<\/strong><\/p>\n\n\n\n Redirecciones (3xx):<\/strong><\/p>\n\n\n\n Errores del cliente (4xx):<\/strong><\/p>\n\n\n\n Errores del servidor (5xx):<\/strong><\/p>\n\n\n\n Aqu\u00ed te dejo un ejemplo de como responder el status code desde Node.JS<\/p>\n\n\n\n <\/p>\n\n\n\n Hasta aqu\u00ed hemos tenido una introducci\u00f3n liviana sobre el uso de Express, en la pr\u00f3xima clase veremos m\u00e1s sobre este tema y tambi\u00e9n como distribuir nuestras archivos dentro de la arquitectura de nuestra aplicaci\u00f3n.<\/p>\n","protected":false},"excerpt":{"rendered":" \u00a1Hola a todos, queridos desarrolladores\/as! Hoy vamos a embarcarnos en un emocionante viaje por el maravilloso mundo de Express, un poderoso framework web para Node.js que nos permitir\u00e1 construir nuestra propia API de manera r\u00e1pida y sencilla. API REST: Explorando opciones para construir APIs En el mundo del desarrollo web, existen varias opciones para construir … Leer m\u00e1s<\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5,3],"tags":[],"class_list":["post-221","post","type-post","status-publish","format-standard","hentry","category-backend-con-node-js","category-curso-de-node-js"],"_links":{"self":[{"href":"https:\/\/danielsegovia.com\/plataforma\/wp-json\/wp\/v2\/posts\/221","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/danielsegovia.com\/plataforma\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/danielsegovia.com\/plataforma\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/danielsegovia.com\/plataforma\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/danielsegovia.com\/plataforma\/wp-json\/wp\/v2\/comments?post=221"}],"version-history":[{"count":4,"href":"https:\/\/danielsegovia.com\/plataforma\/wp-json\/wp\/v2\/posts\/221\/revisions"}],"predecessor-version":[{"id":687,"href":"https:\/\/danielsegovia.com\/plataforma\/wp-json\/wp\/v2\/posts\/221\/revisions\/687"}],"wp:attachment":[{"href":"https:\/\/danielsegovia.com\/plataforma\/wp-json\/wp\/v2\/media?parent=221"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/danielsegovia.com\/plataforma\/wp-json\/wp\/v2\/categories?post=221"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/danielsegovia.com\/plataforma\/wp-json\/wp\/v2\/tags?post=221"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}GET<\/code>, POST<\/code>, PUT<\/code> y DELETE<\/code>. Cada uno de estos m\u00e9todos se utiliza para interactuar con un endpoint espec\u00edfico y realizar una acci\u00f3n determinada en el servidor.<\/p>\n\n\n\n\n
GET \/tareas<\/code>: Utilizado para recuperar todas las tareas.<\/li>\n\n\n\nGET \/tareas\/1<\/code>: Utilizado para recuperar la tarea con el ID 1.<\/li>\n\n\n\nPOST \/tareas<\/code>: Utilizado para crear una nueva tarea.<\/li>\n\n\n\nPUT \/tareas\/1<\/code>: Utilizado para actualizar la tarea con el ID 1.<\/li>\n\n\n\nDELETE \/tareas\/1<\/code>: Utilizado para eliminar la tarea con el ID 1.<\/li>\n<\/ul>\n\n\n\nExpress<\/h2>\n\n\n\n
Configurando velas con Express<\/h3>\n\n\n\n
npm install express<\/code><\/pre>\n\n\n\nconst express = require('express');\nconst app = express();\n\n\/\/ Configuraci\u00f3n de rutas, middleware y otras funcionalidades aqu\u00ed\n\nconst puerto = 5050;\napp.listen(puerto, () => {\n console.log(`\u00a1Zarpamos desde el puerto ${puerto}!`);\n});<\/code><\/pre>\n\n\n\nDefiniendo rutas: Nuestro mapa en el viaje<\/h3>\n\n\n\n
app.get('\/', (req, res) => {\n res.send('Hola Mundo, funcion\u00f3 correctamente');\n});<\/code><\/pre>\n\n\n\nSolicitudes y Respuestas: Comunic\u00e1ndonos con otros navegantes<\/h3>\n\n\n\n
app.get('\/usuario', (req, res) => {\n const usuario = {\n nombre: 'Juan',\n edad: 30,\n ocupacion: 'Desarrollador'\n };\n\n \/\/ Enviamos la respuesta en formato JSON\n console.log(\"respondo con el objeto usuario\"); \/\/ esto no ser\u00e1 parte de la respuesta\n res.json(usuario);\n});<\/code><\/pre>\n\n\n\nA probar<\/h3>\n\n\n\n
![\"\"](\"https:\/\/danielsegovia.com\/plataforma\/wp-content\/uploads\/2023\/07\/Captura-desde-2023-07-30-15-27-14.png\")
<\/a><\/figure>\n<\/div>\n\n\n\n![\"\"](\"https:\/\/danielsegovia.com\/plataforma\/wp-content\/uploads\/2023\/07\/Captura-desde-2023-07-30-15-26-56.png\")
<\/a><\/figure>\n<\/div>\n<\/div>\n\n\n\n\u00bfQu\u00e9 respuesta damos?<\/h3>\n\n\n\n
\n
\n
\n
\n
const express = require('express');\nconst app = express();\nconst port = 3000;\n\napp.get('\/ruta', (req, res) => {\n try {\n \/\/ Simulamos un true o false en el if para responder 200 o 500\n if(true){\n res.status(200).json({ mensaje: 'Todo ha salido correctamente' });\n } else {\n throw new Error('Error interno del servidor');\n }\n } catch (error) {\n \/\/ Respondemos con el c\u00f3digo de estado 500 y un mensaje de error\n res.status(500).json({ error: 'Error interno del servidor' });\n }\n});\n\napp.listen(port, () => {\n console.log(`Servidor Express escuchando en http:\/\/localhost:${port}`);\n});<\/code><\/pre>\n\n\n\nPrep\u00e1rate para el siguiente encuentro<\/h2>\n\n\n\n