📚 Guía para la creación de un API REST.

Esta es una guía hecha para recordar y afianzar la construcción de un API, es un repositorio mas a modo explicativo y de notas para realizar un API REST, pretendo incorporar varias librerías, asi como aprender nuevas y su funcionamiento básico.

como base principal del proyecto, ademas de las siguientes librerías

💡 Ire agregando mas con forme el API valla creciendo.

• Prisma
• Cors
• Morgan
• Bcrypt
• Dotenv

🛠️ Configuraciones básicas del proyecto.

Para comenzar el proyecto procederemos a crear la carpeta contenedora del mismo y nos colocamos dentro de la misma.

mkdir shop_api && cd shop_api

una vez estamos dentro de la carpeta en nuestra terminal procedemos a correr el comando de inicializado de proyecto de node usando npm

npm init -y

lo cual nos creara un archivo llamado package.json donde podremos encontrar la siguiente estructura

{
  "name": "shop_api",
  "version": "0.0.1",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo script test to app"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {},
  "dependencies": {}
}

⚙️ Configurando TypeScript

Ahora bien procederemos a instalar TypeScript y iniciar su configuración para ello podemos usar el siguiente comando:

npm i typescript -D

una vez esta instalado podemos agregar un nuevo script en nuestro package.json para trabajar con typescript, en este caso seria un script para el compilador le pueden poner el nombre que gusten yo lo llamare build

{
  "scripts": {
    "build": "tsc",
    "test": "echo script de test del app"
  }
}

una vez esta listo esto procedemos a ejecutar el comando de la siguiente manera

npm run build -- --init

🔎 Este comando nos inicializa la configuración de typescript en el proyecto, creándonos un archivo tsconfig.json en la raíz de nuestro proyecto. El cual cuenta con un template de las configuraciones que se pueden realizar.

Ahora en nuestro nuevo archivo de configuración de typescript procedemos a ajustar las verificaciones que debe realizar en el compilado de nuestra app. En mi caso usare solo las siguientes configuraciones:

{
  "compilerOptions": {
    "target": "es2016",
    "module": "commonjs",
    "outDir": "./build",
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "noImplicitReturns": true,
    "noFallthroughCasesInSwitch": true,
    "strict": true,
    "skipLibCheck": true,
    "paths": {
      "@/*": ["./*"]
    }
  },
  "exclude": ["node_modules"]
}

📥 Instalación de dependencies.

Ahora con TypeScript listo para trabajar instalaremos las dependencias básicas de nuestro proyecto y las dependencias de desarrollo:

npm i express morgan cors bcrypt dotenv @prisma/client

Ahora las dependencias de desarrollo:

npm i -D prisma ts-node-dev @types/express @types/bcrypt @types/morgan @types/cors

🔧 Scripts funcionales.

Bien hasta ahora ya tenemos todo lo necesario para trabajar, solo faltan un par de ajustes mas como nuestros scripts para desarrollo, producción y pruebas. por el momento creemos nuestros scripts de producción y desarrollo, para ello volvemos a nuestro package.json y agregamos lo siguiente:

{
  "scripts": {
    "start": "node build/index.js",
    "dev": "ts-node-dev src/index.ts",
    "build": "tsc",
  }
}

🗄️ Configurando Prisma y la base de datos.

Prisma es un ORM como lo es Sequelize entre otros, utilizare este ya que me pare mas sencillo de utilizar en comparación con Sequelize, fuero de eso no hay una gran diferencia permite conectase a diversas bases de datos. Para poder empezar a trabajar hay que inicializar prisma en nuestro proyecto para ello seguiremos una serie de pasos que al finalizar nos permitirá tener una base de datos conectada y funcional, con nuestros modelos, semillas y migraciones.

🏁 Inicializando Prisma.

Ya vimos como configurar nuestro proyecto ahora configuraremos nuestro ORM para trabar con el. Como ya hemos instalado Prisma en los pasos anteriores, ya podemos acceder a la linea de comandos de prisma por lo que ejecutaremos el comando de inicio que nos creara una nueva carpeta llamada prisma, y un archivo .env, dentro de la carpeta prisma tendremos un archivo llamado prisma.schema en cual contiene las variables de conexión con nuestra base de datos y el esquema de los modelos que usaremos(tablas o entidades).

npx prisma init

Y listo ahora en el archivo env colocamos nuestro URI para conectarnos con la base de datos de nuestra preferencia, en nuestro caso usaremos una base de datos MySQL, en caso de que quieras utilizar otra puede revisar como debería ser el URI en Prisma Docs Databases:

mysql://USER:PASSWORD@HOST:PORT/DATABASE?connection_limit=5&socket_timeout=3

💡 En el URI se coloca un pool connection con máximo de 5 conexiones y un tiempo de espera de 3 segundos entre las peticiones.

Ahora dentro de la carpeta prisma en nuestro schema procederemos a declarar los modelos que usaremos para crear nuestra base de datos. De igual manera puedes revisar la documentación sobre como crear un modelo en Prisma Docs Models, es recomendable tener la base de datos ya diseñada con anterioridad y tener un camino a seguir predefinido, este el diagrama de la base de datos que utilizare.

Bien ahora que tenemos nuestros modelos declarador poder iniciar con nuestra primera migración, que es la encargada de pasar nuestros modelos a lenguaje SQL y sincronizarlo con nuestra base de datos, y lo podemos realizar con el siguiente comando:

npx prisma migrate dev --name init

💡 Con este comando le indicamos a prima que estamos creando una migración en modo desarrollo y con el --name le indicamos el nombre se le asignara a dicha migración.