Configuración de la API de nodo con TypeScript

Nos guiará a través de los pasos para configurar una API de nodo básica con mecanografiado.

Nota: debe tener Nodejs instalado en su máquina.

Lo primero es crear nuestra carpeta de proyecto e inicializarla con npm para generar el package.json expediente.

Instalar dependencias

npm i express --save
npm i @types/node @types/express ts-node typescript nodemon --save-dev

Crear un tsconfig.json archivo en la raíz de su aplicación o ejecute npx tsc --init en su terminal y agregue la configuración a continuación.

{ 
"compilerOptions":
  {
  "target": "es6",
  "module": "commonjs",
  "allowJs": true,
  "outDir": "./build",
  "rootDir": "./src",
  "esModuleInterop": true
  }
}

Nota: Se pueden agregar más opciones a la tsconfig.json expediente.
Saber más aquí.

Agregue scripts al archivo package.json.

"scripts": 
  {
    "dev": "nodemon src/app.ts",
    	"start": "tsc && node build/app"
    }

Crear un src directorio donde se construiría nuestra aplicación. Dentro de src directorio, cree un app.ts expediente.

Dentro de app.ts archivo, agregue el código a continuación.

import express, { Application, Request, Response, NextFunction } from "express";

const app: Application = express();

app.use(express.json());

app.get("/", (req: Request, res: Response): object => {
    return res.json({ status: "success", message: "Welcome to API Service" });
  }
);

app.use((req: Request, res: Response, next: NextFunction) => {
  const error = new Error("Route Not found");
  next(error);
});

app.use((error: { message: string; status: number }, req: Request, res: Response,next: NextFunction
  ) => {
    res.status(error.status || 500);
    res.json({
      status: "error",
      message: error.message
    });
    next();
  }
);

const PORT: any = process.env.PORT || 3000;

app.listen(PORT, () => console.log(`app listening on port ${PORT}`));

En este punto, la estructura de su proyecto debería verse como la imagen a continuación.

Estructura del proyecto

Desarrollo 👨🏾‍💻

Para ejecutar la aplicación en el entorno de desarrollo, ejecute el siguiente comando

npm run dev

Nota: El comando anterior compila los archivos que se encuentran en el directorio src en la memoria.

Producción 🚀

Para ejecutar la aplicación en el entorno de producción, ejecute el siguiente comando

npm start

Nota: El comando anterior compila los archivos que se encuentran en el src directorio a un build directorio y ejecuta el archivo app.js en el build directorio, como se especifica arriba en el start script en nuestro package.json expediente.

El proyecto utilizado en este artículo se puede encontrar aquí.

Si tiene alguna pregunta o comentario, por favor deje un comentario.

Gracias por leer.

Similar Posts

Leave a Reply

Your email address will not be published.