Un primer proyecto con Node.js

Introducción

La finalidad de este capítulo es poner en práctica los diferentes conceptos aprendidos en los capítulos anteriores del libro. El objetivo es desarrollar una API utilizando TypeScript y Node.js. Se construirá en varias etapas para poder explicar paso a paso los conceptos que se ponen en práctica.

Para desarrollar esta API, es necesario apoyarse en una arquitectura REST (REpresentational State Transfer). Este estilo de arquitectura se basa en verbos y códigos HTTP para simplificar la comprensión y el uso de una API.

Como parte de esta práctica, se creará un directorio empresarial para administrar los empleados de una sociedad.

Para manipular una API Rest, es preciso utilizar un cliente. No es necesario instalar software para ello; más adelante, en este capítulo, se configurará un explorador de API, que estará disponible directamente cuando se inicie el programa. Sin embargo, antes de configurar este explorador, realizará las primeras pruebas de llamada...

Configurar el proyecto

En esta sección, configurará la estructura del proyecto.

npm init -y 

"name": "employee-directory" 

"private": true 

{  
  "name": "employee-directory",  
  "version": "1.0.0",  
  "description": "",  
  "main": "index.js",  
  "scripts": {  
    "test": "echo \"Error: no test specified\" && exit 1"  
  },  
  "keywords": [],  
  "author":...

Crear el framework MVC

Model-View-Controller (MVC) es un patrón de diseño muy popular para desarrollar aplicaciones web. En una aplicación MVC, las responsabilidades se dividen entre los siguientes elementos:

Estas partes interactúan según el siguiente diagrama:

En esta sección, creará la parte del controlador. La pieza del modelo se colocará más adelante.

export type HttpVerb = "get"; 

export interface IRoute {  
  controller: string;  
  action: string;  
  httpVerb: HttpVerb;  
  path: string;  
} 

import type { IRoute } from "./types";...

Validación y OpenApi

En esta parte, se trata de configurar la creación de empleados en el directorio de la empresa. Para hacer esto, es necesario crear una acción que se ejecutará durante una llamada HTTP de tipo POST. Los datos proporcionados en el cuerpo de la solicitud se validan mediante un esquema JSON. Fastify implementa de forma nativa la validación de documentos JSON a través de la especificación JSON Schema (https://json-schema.org/).

Una de las ventajas de confiar en la validación de esquemas es que también permite, a través de otras bibliotecas del ecosistema Fastify, configurar una descripción y un explorador API de tipo OpenApi (https://www.openapis.org/).

type SchemaBaseProperty = {  
  description: string;  
}; 

type SchemaIntegerProperty = {  
  
  type: "integer";  
  minimum?: number;  
}; 

type SchemaStringProperty = {  
  type: "string";  
  pattern?: string;  
}; 

Acceso a datos y su persistencia

Acceder a los datos y conservarlos directamente desde un controlador se considera una mala práctica porque multiplica las responsabilidades del controlador y no permite la reutilización de ese código.

Se trata, por tanto, de implementar una verdadera capa de acceso a los datos utilizando el patrón de diseño Repository. Este permite desacoplar la persistencia de los datos del resto de la aplicación al ofrecer una capa de abstracción (correspondiente a un repositorio de datos) y se puede utilizar independientemente del modo de persistencia de los datos (base de datos SQL, archivo plano, datos en memoria...). Este patrón de diseño aumenta la capacidad de prueba y mantenimiento del programa. Gracias a la genericidad, centraliza la forma de manejar los diferentes objetos de negocio de la aplicación, evitando así la duplicación de código.

export interface IEntity {  
  id: string;  
} 

import type { IEntity } from "../core/data/types"; 

export class Employee implements IEntity {  
  id!: string;  
} 

firstName!: string;  
lastName!: string;  
email!: string;  
salary!: number; 

Inversión de dependencias

En la sección anterior, la propia clase Repository crea una instancia de la clase MemoryStorage, para poder usarla como una abstracción en el resto de la clase (definida por la interfaz IStorage). Esta implementación no respeta el principio SOLID de inversión de dependencias (consulte el capítulo Programación orientada a objetos).

En esta sección se trata de configurar la inyección de dependencias para respetar este principio y, por lo tanto, desacoplar Repository del almacenamiento de datos. Además, definirá una implementación de la interfaz IStorage para conservar datos en un archivo. Luego, esta implementación se puede cambiar en el nivel de un contenedor de dependencias para inyectarla en el repositorio. 

export class DependencyContainer {  
  
} 

static #instance: DependencyContainer; 

private constructor() {  
  
} 

static getInstance(): DependencyContainer {  
  if (!this.#instance) {  
    this.#instance...