首页 > web前端 > js教程 > 如何在 5 时间内使用 TypeScript 设置 Node.js API

如何在 5 时间内使用 TypeScript 设置 Node.js API

Linda Hamilton
发布: 2025-01-03 18:01:40
原创
411 人浏览过

How to Set Up a Node.js API with TypeScript in 5

如今,使用 Node.js 和 TypeScript 创建高效且可扩展的 API 比以往任何时候都更简单、更强大。在 CodeInit,我们的目标是提供实用且简单的教程,帮助您构建满足市场需求的专业解决方案。在本文中,我将引导您使用 2025 年最佳实践逐步设置现代 API。

无论您是初学者还是希望提高工作流程的经验丰富的开发人员,本指南都适合您。让我们一起来深入了解吧!

为什么使用 Node.js 和 TypeScript?

Node.js 仍然是最流行的后端技术之一,与 TypeScript 结合使用时,您可以两全其美:速度和安全性。 TypeScript 添加了静态类型,使您的代码更易于维护并减少常见错误。

2025 年,掌握提高生产力并符合市场趋势的工具至关重要。

开始之前您需要什么

开始之前,请确保您的环境设置正确。以下是先决条件:

  • Node.js 20 或更高版本
  • 文本编辑器 – 我推荐 Visual Studio Code
  • JavaScript 和终端的基础知识
  • 系统上安装了 npm、yarn 或 pnpm

提示:使用 VS Code 中的集成终端可以更轻松地遵循本教程。

就我个人而言,我喜欢使用 pnpm。要全局安装 pnpm,请使用以下命令:

npm i -g pnpm
登录后复制
登录后复制

第 1 步:设置环境

首先,确保安装了 Node.js:

node -v
登录后复制
登录后复制

如果一切设置正确,您应该会看到 Node.js 版本。否则,请从官方网站下载最新版本。

现在,让我们创建项目结构:

mkdir my-api && cd my-api
pnpm init -y
登录后复制
登录后复制

此命令创建 package.json 文件,用于管理项目依赖项。

第 2 步:安装 TypeScript

TypeScript 对于维护和组织大型项目至关重要。让我们安装它:

pnpm install typescript tsx @types/node -D
登录后复制
登录后复制

接下来,通过创建 tsconfig.json 文件来配置 TypeScript:

npx tsc --init
登录后复制
登录后复制

编辑文件以反映 2025 年的最佳实践:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "CommonJS",
    "strict": true,
    "outDir": "dist",
    "rootDir": "src"
  }
}
登录后复制
登录后复制

创建 src 目录来组织您的代码:

mkdir src
登录后复制
登录后复制

第 3 步:添加 ESLint

维护干净的代码至关重要。让我们添加 ESLint 以确保质量和标准化。

使用以下命令配置 ESLint:

pnpm create @eslint/config@latest
登录后复制
登录后复制

推荐的 ESLint 设置

  • 您想如何使用 ESLint? (检查语法并发现问题)
  • 您的项目使用什么类型的模块? (JavaScript 模块(导入/导出))
  • 您的项目使用哪个框架? (无)
  • 您的项目使用 TypeScript 吗? (是的)
  • 你的代码在哪里运行? (节点)
  • 您想现在安装它们吗? (是的)

安装后,将在项目根目录中创建 eslint.config.js 文件。

这是一个示例配置:

npm i -g pnpm
登录后复制
登录后复制

添加 ESLint 命令

将以下脚本添加到package.json:

node -v
登录后复制
登录后复制

第一个命令运行 ESLint 并在控制台中显示错误,而第二个命令尝试自动修复错误。

运行:

mkdir my-api && cd my-api
pnpm init -y
登录后复制
登录后复制


pnpm install typescript tsx @types/node -D
登录后复制
登录后复制

第 4 步:构建 API

创建健康检查路由

现在是时候开始使用您的 API 了。让我们使用 Express,一个 Node.js 的极简框架。

安装 Express 及其类型:

npx tsc --init
登录后复制
登录后复制

创建 src/index.ts 文件并添加以下代码:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "CommonJS",
    "strict": true,
    "outDir": "dist",
    "rootDir": "src"
  }
}
登录后复制
登录后复制

将以下脚本添加到package.json:

mkdir src
登录后复制
登录后复制

运行:

pnpm create @eslint/config@latest
登录后复制
登录后复制

访问:http://localhost:3000/health 检查 API 运行状况。

添加神奇宝贝路线

让我们通过返回 Pokémon 列表的路由来扩展 API。

使用以下代码更新 src/index.ts:

import pluginJs from '@eslint/js';
import globals from 'globals';
import tseslint from 'typescript-eslint';

/** @type {import('eslint').Linter.Config[]} */
export default [
  { files: ['**/*.{js,mjs,cjs,ts}'] },
  { languageOptions: { globals: globals.node } },
  pluginJs.configs.recommended,
  ...tseslint.configs.recommended,
  {
    rules: {
      semi: 'off',
      quotes: ['error', 'single']
    }
  }
];
登录后复制

测试路由:http://localhost:3000/pokemons。

结论

在本指南中,您学习了如何使用 Node.js 和 TypeScript 设置现代 API,从简单的路线开始并将其扩展为包含类型化数据。这只是开始!有了这个基础,您就可以实现身份验证、数据库连接等等。

如果您发现本文有帮助,请与其他开发人员分享并订阅我们的时事通讯以获取更多提示。让我们一起征服开发世界! ?

以上是如何在 5 时间内使用 TypeScript 设置 Node.js API的详细内容。更多信息请关注PHP中文网其他相关文章!

来源:dev.to
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
作者最新文章
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板