10.13. Creación de una API REST básica con NodeJS y ExpressJS: implementación de API

Página 78

Una vez que haya creado una API REST básica con NodeJS y ExpressJS, el siguiente paso es implementar la API. Implementar una API es el proceso de colocarla en un servidor web para que otras personas puedan acceder a ella a través de Internet. En esta sección, cubriremos el proceso de implementación de una API REST básica creada con NodeJS y ExpressJS.

En primer lugar, es importante comprender que para implementar una API, necesita un servidor. Hay muchos proveedores de hosting que ofrecen servidores que pueden utilizarse para este fin. Algunos ejemplos populares incluyen Amazon Web Services (AWS), Google Cloud Platform (GCP) y Heroku. Para este tutorial, usaremos Heroku ya que es fácil de usar y ofrece un nivel gratuito que es suficiente para nuestras necesidades.

Para comenzar, debe crear una cuenta Heroku. Después de crear su cuenta, puede crear una nueva aplicación. Heroku le pedirá que le dé un nombre a su aplicación y elija una región del servidor. Después de crear la aplicación, accederá a la página del panel de control de la aplicación, donde podrá configurar los ajustes de la aplicación e implementar su código.

Antes de implementar su código, debe realizar algunos cambios en su proyecto. Primero, necesitas agregar un archivo llamado Procfile a la raíz de tu proyecto. Este archivo le dice a Heroku cómo iniciar su aplicación. Para una API creada con NodeJS y ExpressJS, el contenido del archivo Procfile debe ser:

web: nodo index.js

Reemplace "index.js" con el nombre del archivo que inicia su servidor.

A continuación, debe modificar su archivo package.json para incluir un script de inicio. Heroku utilizará este script para iniciar su aplicación. Agregue la siguiente línea a la sección scripts de su archivo package.json:

"inicio": "nodo index.js"

Nuevamente, reemplace "index.js" con el nombre del archivo que inicia su servidor.

Una vez que haya realizado estos cambios, puede implementar su código en Heroku. Heroku admite varios métodos de implementación, pero el más simple es usar Git. Si aún no tienes Git instalado, necesitarás instalarlo. Luego puedes inicializar un nuevo repositorio Git en la raíz de tu proyecto con el siguiente comando:

inicio de git

Una vez que haya inicializado el repositorio de Git, puede agregar todos los archivos de su proyecto al repositorio con el siguiente comando:

git agregar.

Luego puedes confirmar tus cambios con el siguiente comando:

git commit -m "Compromiso inicial"

Ahora puedes implementar tu código en Heroku con los siguientes comandos:

inicio de sesión heroku
git push heroku maestro

El primer comando le pedirá que inicie sesión en su cuenta Heroku. El segundo comando implementará su código en Heroku.

Después de implementar su código, puede acceder a su API a través de Internet. La URL de su API será algo así como "https://nombre-de-su-aplicación.herokuapp.com". Puedes probar tu API realizando una solicitud HTTP a esta URL.

¡Felicitaciones! Acaba de implementar una API REST básica con NodeJS y ExpressJS. Ahora otras personas pueden acceder a su API a través de Internet. Este es un paso importante en la creación de API, ya que permite que otras personas utilicen su API para crear sus propias aplicaciones.

Siguiente página del libro electrónico gratuito:

7911. Trabajar con JSON en NodeJS