Express TypeScript API

Express TypeScript API

TypeScript に対応した、空の Express サーバーセットアップです。

プロジェクト構成

express-typescript-api/
├── src/                  # Source files
│   ├── config/           # Configuration files
│   ├── routes/           # API routes
│   └── server.ts         # Express application setup
├── dist/                 # Compiled JavaScript files
├── .gitignore            # Git ignore file
├── package.json          # Project metadata and dependencies
├── tsconfig.json         # TypeScript configuration
└── README.md             # Project documentation

前提条件

• Node.js（v14.x 以上を推奨）
• npm（v6.x 以上）

インストール

1. リポジトリをクローンします。

   git clone <repository-url>
   cd express-typescript-api
   

2. 依存関係をインストールします。

   npm install
   

開発

ホットリロードを有効にして開発サーバーを起動するには、次のコマンドを実行します。

npm run dev

サーバーは http://localhost:3000 で起動します。

本番環境向けのビルド

TypeScript コードを JavaScript にコンパイルするには、次のコマンドを実行します。

npm run build

コンパイルされた JavaScript ファイルは dist ディレクトリに作成されます。

本番環境での実行

コンパイルされた JavaScript を本番環境で実行するには、次のコマンドを実行します。

npm start

利用可能な API エンドポイント

• GET /：ウェルカムメッセージを返します
• GET /health：ヘルスチェック用エンドポイントです

環境変数

ルートディレクトリに次の変数を含む .env ファイルを作成します。

NODE_ENV=development
PORT=3000

新しいルートの追加

1. src/routes ディレクトリに新しいルートファイルを作成します
2. src/server.ts でルートをインポートして使用します

ライセンス

ISC