ホームページ > ウェブフロントエンド > jsチュートリアル > 5 で TypeScript を使用して Node.js API をセットアップする方法

5 で TypeScript を使用して Node.js API をセットアップする方法

Linda Hamilton
リリース: 2025-01-03 18:01:40
オリジナル
447 人が閲覧しました

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

現在、Node.js と TypeScript を使用して効率的でスケーラブルな API を作成することが、これまでよりも簡単かつ強力になっています。 CodeInit では、市場の需要を満たすプロフェッショナルなソリューションを構築するのに役立つ、実践的でわかりやすいチュートリアルを提供することを目指しています。この記事では、2025 年のベスト プラクティスを使用して最新の API を設定する手順を段階的に説明します。

初心者でも、ワークフローを強化したいと考えている経験豊富な開発者でも、このガイドはあなたのためのものです。一緒に飛び込んでみましょう!

Node.js と TypeScript を使用する理由

Node.js は依然として最も人気のあるバックエンド テクノロジの 1 つであり、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 のバージョンが表示されるはずです。それ以外の場合は、公式 Web サイトから最新バージョンをダウンロードしてください。

次に、プロジェクト構造を作成しましょう:

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 を実行してコンソールにエラーを表示し、2 番目のコマンドはエラーを自動的に修正しようとします。

実行:

mkdir my-api && cd my-api
pnpm init -y
ログイン後にコピー
ログイン後にコピー

または

pnpm install typescript tsx @types/node -D
ログイン後にコピー
ログイン後にコピー

ステップ 4: API の構築

ヘルスチェックルートの作成

いよいよ API の使用を開始します。 Node.js のミニマリスト フレームワークである Express を使用してみましょう。

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
ログイン後にコピー
ログイン後にコピー

API の健全性を確認するには、http://localhost:3000/health にアクセスしてください。

ポケモンルートの追加

ポケモンのリストを返すルートを使用して 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 中国語 Web サイトの他の関連記事を参照してください。

ソース:dev.to
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
著者別の最新記事
人気のチュートリアル
詳細>
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート