.js es un tiempo de ejecución de Javascript que se basa en el motor Javascript V8 de Chrome. Node está diseñado para crear aplicaciones de red escalables. Nuestro objetivo en este artículo es construir una API REST usando Node.js. Construiremos un servicio de calculadora simple que hará cálculos básicos y devolverá las salidas generadas.
¿Qué es una API REST?
Simplemente una API RESTful es una interfaz de programación de aplicaciones (API) que utiliza la solicitud HTTP para OBTENER, PUBLICAR, PONER y ELIMINAR datos. También conocido como servicios web RESTful. REST significa Transferencia de Estado de representación, que es un estilo arquitectónico para el desarrollo de servicios web.
¿Qué vamos a construir?
Construiremos un servicio web simple que hará algunos cálculos y devolverá los valores. Las URL de solicitud y la salida se verán así.
Lo que necesitas
- Un pequeño y agradable editor de código como Visual Studio Code.
- Nodo.js instalado en su sistema.
- Un marco de servicio — En este artículo estoy usando hapi.js (pronunciado como Happy JS)
- Una aplicación como POSTMAN (una extensión de aplicación de Chrome) para probar nuestro servicio.
Estoy en macOS High Sierra versión 10.13.3. Los comandos del shell deben ser similares en otras plataformas.
Vamos a empezar
Haga clic aquí para obtener la muestra de trabajo completa.
En primer lugar, debe verificar la versión de Node.js que tienes. Abra un terminal y escriba el siguiente comando para verificar la versión del Nodo.js que tienes. Estoy usando la versión 8.9.4
$ node --version
OK, ahora cree un directorio para almacenar su código y navegue por él utilizando los siguientes comandos de shell.
$ mkdir calc-service
$ cd calc-service
Permite crear nuestro proyecto.archivo json, escribiendo este comando.
$ npm init
Responda las preguntas y su proyecto.el archivo json debería tener este aspecto.
bueno, ahora que hemos creado la base de nuestro Nodo.servicio js. Lo siguiente que necesitamos es instalar el hapi.js framework. hapi.js es un marco rico que le permite crear aplicaciones web, así como servicios basados en nodos.js.
Permite ir a la terminal y escribir e introducir el siguiente comando.
$ npm install --save [email protected]
npm es un gestor de paquetes que le permite instalar miles de módulos para trabajar con Node.js. Si nos fijamos en el comando anterior, hemos dado instrucciones al npm para que instale la versión 17 de hapi. También hemos pedido actualizar el paquete.archivo json usando la opción guardar.
Ahora su estructura de carpetas debería tener este aspecto.
Como puede ver el hapi.la dependencia de js se ha actualizado en el paquete.se actualizan el archivo json y los módulos de nodo necesarios.
Vamos a crear el servidor ahora
En este paso buscaremos crear un servidor que escuche nuestras solicitudes. En el terminal escriba el siguiente comando para crear el servidor.archivo js. Esto debe estar en la raíz del directorio en el que se encuentra. O puede usar Nuevo archivo en la pestaña del panel izquierdo en Código VS.
$ touch server.js
le Permite agregar el siguiente código en el servidor.archivo js. Este código creará código que escuchará las solicitudes de los usuarios en un puerto determinado.
Permite comprobar, si el servidor está en marcha y funcionando. Abra el terminal y el siguiente comando.
$ node server.js
Y deberías ver una salida como esta.
Crear nuestra primera ruta
Ahora hemos probado con éxito el servidor. Nuestro servidor está en funcionamiento ahora. Es hora de crear la primera ruta. Comencemos simple creando este camino.
/calculator/about
Abra el servidor.js y agregue el siguiente código, justo antes de init ().
el código Anterior crea una ruta, un camino de /calculadora/acerca del uso de un método GET. En la función de controlador de línea 4, se encarga de la solicitud y se envía una respuesta como respuesta. En la línea 5 hemos creado una variable que almacena una cadena JSON. Finalmente, line devuelve esa variable como una respuesta del servidor.
Ahora hemos añadido nuestra primera ruta al servidor. Hagamos una prueba rápida del nuevo código. En el terminal, escriba el siguiente comando para iniciar el servidor. (Puede detener el servidor presionando CTRL + C)
$ node server.js
Activamos a POSTMAN y probamos nuestra primera ruta.
Como puede ver, hemos utilizado el método GET para enviar la solicitud y la URL coincide con la ruta de la ruta. Tenemos un retorno exitoso del servidor como una cadena JSON.
Excelente tenemos un código de trabajo ahora mismo. Es una buena práctica organizar un código un poco. A pesar de que esta es una aplicación pequeña, siempre es una buena práctica hacerlo. Movamos nuestro código de enrutamiento a una carpeta y un archivo separados.
Primero detengamos el servidor pulsando CTRL + C en el terminal. Y en el directorio raíz, cree un directorio llamado routes. Utilice los siguientes comandos en el terminal o puede crearlo utilizando Código VS.
$ mkdir routes
$ cd routes
$ touch routes.js
Ahora la estructura de directorios debería tener este aspecto.
Ahora abra la ruta.archivo js dentro de código VS. A continuación, corte el código que escribimos para enrutar en el servidor.archivo js. Y pegar dentro de la ruta.archivo js. Ahora abra de nuevo el servidor.el archivo js agrega el siguiente código justo antes de la llamada al método init ().
require(‘./routes/routes’)(server);
Ahora tenemos un poco organizado código. Agreguemos el resto de las rutas a las rutas.archivo js.
Ahora, todas nuestras rutas están intactos. Si nos fijamos en los números de línea 19, 36, 53 y 70, el trazado tiene dos entradas dentro de corchetes {}. Estos se tratan como parámetros en la ruta. Puede acceder a estos parámetros como se muestra en las líneas 22 y 23. El descanso se explica por sí mismo.
Ahora permite marcar el servidor escribiendo este comando en el terminal y probarlo con POSTMAN.
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!