¿Cómo usar TypeScript para compilar la API de Node.js con Express? – Part 1

En este artículo, discutiremos cómo crear una ruta rápida y una API en TypeScript y nos ayudaremos con el mecanismo de verificación de tipos predeterminado. Y crearemos algunos puntos finales de API falsos con la ayuda de TypeScript con la configuración de ExpressJS y entenderemos cómo usar TypeScript en nuestro proyecto ExpressJS.

TypeScript es un superconjunto de JavaScript con algunas características adicionales que JavaScript no tiene, como la notación de tipo y el cambio de tipo estático o el uso del código de es6 en bases de código más antiguas. Typescript proporciona todas las funciones. Si desea crear un servicio de API en el uso de TypeScript de express con NodeJS, primero debe configurar su proyecto con TypeScript. Si no tiene idea de cómo configurar express en TypeScript, consulte este artículo.

Espero que haya configurado su proyecto Express con TypeScript usando el artículo anterior ahora comenzaremos a crear nuestra primera API en TypeScript. 

requisitos previos:

• Conocimientos básicos sobre NodeJs.
• Conocimientos básicos sobre Express Js y sus técnicas de gestión de rutas.
• Conocimientos básicos sobre TypeScript y sus usos.

Enfoque:  Configuración de la estructura del directorio de acuerdo con el artículo mencionado anteriormente. Inicie ExpressJs con TypeScript. Creará dos API falsas para crear un usuario y obtener datos de usuario con la configuración de ExpressJs TypeScript. Ver el archivo de código base final. Probaremos nuestros puntos finales de API con la ayuda de la herramienta de prueba de API de Postman y veremos el resultado de nuestra API.

Paso 1: si ha configurado el proyecto en el uso del artículo anterior, su directorio se verá así.

Paso 2: Abra el archivo index.ts y escriba el siguiente código. En primer lugar, cree un código ExpressJs en TypeScript y siga las buenas prácticas.

Nombre de archivo: index.js 

// Import the express with express name
import express from 'express';
 
// Initialize the express module with app variable
const app: express.Application = express();
 
// Define the port for the application is run
const port: number = 3000;
 
// Handle the coming data.
app.use(express.json());
 
// Handle '/', path of the api.
app.get('/', (_req, _res): void => {
    _res.json({
        'name': 'typescitp_api',
        'path': '/',
        'work': 'search_other_apis'
    });
});
 
 
// Server the api endpoints.
app.listen(port, (): void => {
    console.log(`Typescript API server http://localhost:${port}/`);
});

 
Paso 3: en este paso, creamos dos puntos finales de API para crear el usuario y obtener los datos de los usuarios. En primer lugar, cree una array global para tratarla como una base de datos falsa.

Sintaxis: 

let fake_db: any = [];

Luego, cree un primer punto final de API para crear los usuarios y almacenar los datos de los usuarios en la base de datos falsa. Estamos trabajando con el punto final de la API, por lo que los datos se pasan a través del método de publicación o el formato de datos JSON. En el siguiente código, primero manejamos una solicitud de publicación y creamos una ruta ‘/ crear’ para administrar o crear el punto final de la API del usuario y luego asignamos los datos del cuerpo entrante a nuestra base de datos falsa y devolvemos el resultado apropiado.

Nombre de archivo: index.js

// Handle '/create', path for create user
app.post('/create', (_req, _res): void => {
 
    // Fetched the user using body data
    const user: object = _req.body;
 
    // Assign the user in fake_db with id as a index
    fake_db.push(user);
 
    _res.json({
        "success": true,
        "data": user
    });
});

Después de escribir todos los códigos, pasemos a la fase de prueba y miremos lo que genera nuestra API.

Paso 5: Ahora el paso final es probar todas las rutas creadas usando Postman. Si no sabe sobre el cartero, consulte este artículo.

1. Pruebe la ruta raíz ‘/’ usando cartero.

La ruta raíz funciona correctamente, por lo que nos estamos moviendo a otro punto final de la API.

2. Pruebe la ruta ‘/create’ en la solicitud de publicación usando cartero.

Pasamos datos JSON sin procesar directamente.

3. Pruebe la ruta ‘/usuarios’ usando cartero.