如何使用 TypeScript 通过 Express 构建 Node.js API？

在本文中，我们将讨论如何在 TypeScript 中创建 Express Route 和 API，并帮助我们使用默认的类型检查机制。我们将在 TypeScript 和 ExpressJS 配置的帮助下创建一些 Fake API 端点，并了解如何在我们的 ExpressJS 项目中使用 TypeScript。

TypeScript 是 JavaScript 的超集，具有一些 JavaScript 不具备的附加功能，例如类型表示法和静态类型更改或在旧代码库中使用 es6 的代码。 Typescript 提供了所有功能。如果你想在 NodeJS 中使用 express 的 typescript 创建 API 服务，你必须首先使用 typescript 设置你的项目。如果您不知道如何在 typescript 中设置 express，请参阅本文。

我希望你已经使用上面的文章使用 typescript 设置了你的 express 项目，现在我们将开始在 Typescript 中创建我们的第一个 API。

先决条件：

• 关于 NodeJs 的基础知识。
• 关于 Express Js 及其路由管理技术的基础知识。
• 关于 TypeScript 及其用途的基本知识。

方法：根据上述文章设置目录结构。使用 TypeScript 启动 ExpressJs。将创建两个假 API 来创建用户并使用 ExpressJs TypeScript 配置获取用户数据。查看最终的代码库文件。将在 Postman API 测试工具的帮助下测试我们的 API 端点并查看我们的 API 输出。

第 1 步：如果您使用上述文章设置项目，您的目录如下所示。

第 2 步：打开 index.ts 文件并编写以下代码。首先，在 TypeScript 中创建一个 ExpressJs 代码并流化良好实践。

文件名：index.js

Javascript

// 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}/`);
});

第 3 步：在这一步中，我们创建了两个 API 端点，用于创建用户和获取用户数据。首先创建一个全局数组，将其视为假数据库。

句法：

let fake_db: any = [];

然后创建第一个 API 端点来创建用户并将用户数据存储在假数据库中。我们正在使用 API 端点，因此数据通过 post 方法或 JSON 数据格式传递。在下面的代码中，我们首先处理一个发布请求并创建一个“/create”路由来管理或创建用户 API 端点，然后将即将到来的正文数据分配给我们的假数据库并返回适当的输出。

文件名：index.js

Javascript

// 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
    });
});

在编写完所有代码之后，让我们进入测试阶段，看看我们的 API 输出了什么。

第 5 步：现在最后一步是使用 Postman 测试所有创建的路由。如果您不了解邮递员，请参阅本文。

1.使用邮递员测试'/'根路径。

根路径正常工作，因此我们正在移动到另一个 API 端点。

2. 使用 postman 在 post 请求中测试 '/create' 路径。

我们直接传递原始 JSON 数据。

3. 使用邮递员测试'/users' 路径。