Rumah >hujung hadapan web >tutorial js >Cara Menyediakan API Node.js dengan TypeScript dalam 5

Cara Menyediakan API Node.js dengan TypeScript dalam 5

Linda Hamilton
Linda Hamiltonasal
2025-01-03 18:01:40515semak imbas

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

Kini, mencipta API yang cekap dan berskala dengan Node.js dan TypeScript adalah lebih mudah dan lebih berkuasa berbanding sebelum ini. Di CodeInit, kami menyasarkan untuk menyampaikan tutorial praktikal dan mudah untuk membantu anda membina penyelesaian profesional yang memenuhi permintaan pasaran. Dalam artikel ini, saya akan membimbing anda langkah demi langkah melalui penyediaan API moden menggunakan amalan terbaik untuk 2025.

Sama ada anda seorang pemula atau pembangun berpengalaman yang ingin meningkatkan aliran kerja anda, panduan ini adalah untuk anda. Mari kita menyelaminya bersama-sama!

Mengapa Menggunakan Node.js dan TypeScript?

Node.js kekal sebagai salah satu teknologi bahagian belakang yang paling popular, dan apabila digabungkan dengan TypeScript, anda mendapat yang terbaik dari kedua-dua dunia: kelajuan dan keselamatan. TypeScript menambah penaipan statik, menjadikan kod anda lebih mudah untuk diselenggara dan mengurangkan ralat biasa.

Pada tahun 2025, menguasai alatan yang meningkatkan produktiviti dan selaras dengan arah aliran pasaran adalah penting.

Apa yang Anda Perlukan Sebelum Bermula

Sebelum bermula, pastikan persekitaran anda disediakan dengan betul. Berikut adalah prasyarat:

  • Node.js 20 atau lebih baru
  • Editor Teks – Saya mengesyorkan Kod Visual Studio
  • Pengetahuan asas JavaScript dan terminal
  • npm, benang atau pnpm dipasang pada sistem anda

Petua: Gunakan terminal bersepadu dalam Kod VS untuk mengikuti tutorial ini dengan lebih mudah.

Secara peribadi, saya suka menggunakan pnpm. Untuk memasang pnpm secara global, gunakan arahan di bawah:

npm i -g pnpm

Langkah 1: Sediakan Persekitaran

Pertama, pastikan Node.js dipasang:

node -v

Jika semuanya disediakan dengan betul, anda seharusnya melihat versi Node.js. Jika tidak, muat turun versi terkini daripada tapak web rasmi.

Sekarang, mari buat struktur projek:

mkdir my-api && cd my-api
pnpm init -y

Arahan ini mencipta fail package.json, yang menguruskan kebergantungan projek.

Langkah 2: Memasang TypeScript

TypeScript adalah penting untuk menyelenggara dan mengatur projek yang lebih besar. Mari pasang:

pnpm install typescript tsx @types/node -D

Seterusnya, konfigurasikan TypeScript dengan mencipta fail tsconfig.json:

npx tsc --init

Edit fail untuk mencerminkan amalan terbaik untuk 2025:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "CommonJS",
    "strict": true,
    "outDir": "dist",
    "rootDir": "src"
  }
}

Buat direktori src untuk mengatur kod anda:

mkdir src

Langkah 3: Menambah ESLint

Mengekalkan kod yang bersih adalah penting. Mari tambah ESLint untuk memastikan kualiti dan penyeragaman.

Gunakan arahan di bawah untuk mengkonfigurasi ESLint:

pnpm create @eslint/config@latest

Tetapan ESLint Disyorkan

  • Bagaimanakah anda ingin menggunakan ESLint? (Untuk menyemak sintaks dan mencari masalah)
  • Apakah jenis modul yang digunakan oleh projek anda? (Modul JavaScript (import/eksport))
  • Rangka kerja manakah yang digunakan oleh projek anda? (Tiada)
  • Adakah projek anda menggunakan TypeScript? (Ya)
  • Di manakah kod anda dijalankan? (Nod)
  • Adakah anda mahu memasangnya sekarang? (Ya)

Setelah dipasang, fail eslint.config.js akan dibuat dalam akar projek.

Berikut ialah contoh konfigurasi:

npm i -g pnpm

Tambah Perintah ESLint

Tambahkan skrip berikut pada package.json:

node -v

Arahan pertama menjalankan ESLint dan memaparkan ralat dalam konsol, manakala yang kedua cuba membetulkan ralat secara automatik.

Lari:

mkdir my-api && cd my-api
pnpm init -y

atau

pnpm install typescript tsx @types/node -D

Langkah 4: Membina API

Mencipta Laluan Pemeriksaan Kesihatan

Kini tiba masanya untuk bermula dengan API anda. Mari gunakan Express, rangka kerja minimalis untuk Node.js.

Pasang Express dan jenisnya:

npx tsc --init

Buat fail src/index.ts dan tambah kod berikut:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "CommonJS",
    "strict": true,
    "outDir": "dist",
    "rootDir": "src"
  }
}

Tambahkan skrip berikut pada package.json:

mkdir src

Lari:

pnpm create @eslint/config@latest

Lawati: http://localhost:3000/health untuk menyemak kesihatan API.

Menambah Laluan Pokémon

Mari kembangkan API dengan laluan yang mengembalikan senarai Pokémon.

Kemas kini src/index.ts dengan kod berikut:

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']
    }
  }
];

Uji laluan: http://localhost:3000/pokemons.

Kesimpulan

Dalam panduan ini, anda mempelajari cara menyediakan API moden dengan Node.js dan TypeScript, bermula dengan laluan mudah dan mengembangkannya untuk memasukkan data yang ditaip. Ini baru permulaan! Dengan asas ini, anda boleh melaksanakan pengesahan, sambungan pangkalan data dan banyak lagi.

Jika anda mendapati artikel ini membantu, kongsikannya dengan pembangun lain dan langgan surat berita kami untuk mendapatkan lebih banyak petua. Mari kita menakluki dunia pembangunan bersama-sama! ?

Atas ialah kandungan terperinci Cara Menyediakan API Node.js dengan TypeScript dalam 5. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!

Kenyataan:
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn