NestJSのルーティングでハマらないために：静的パスと動的パスの順序に気をつけよう

はじめに

NestJS(express.js)のルーティングにおいて、静的パスと動的パスの定義順序がアプリケーションの動作に重大な影響を与えることがあります。この順序を理解して正しく設定することで、予期しないルーティングエラーを回避することが可能です。本記事では、NestJSにおけるルーティングの基本から、静的パスと動的パスの定義順序に関する具体的な問題点とその解決策までを紹介します。

1. NestJSのルーティングの基本

NestJSでは、コントローラとHTTPメソッドデコレータを使用してルーティングを定義します。@Controller デコレータはクラスをコントローラとして定義し、@Get、@Post などのHTTPメソッドデコレータが特定のルートに対応するメソッドを指定します。

コード例

以下の例では、/users に関連するルーティングを設定しています。

    import { Controller, Get } from '@nestjs/common';

    @Controller('users')
    export class UsersController {
      @Get('profile')
      getUserProfile() {
        return 'User profile details';
      }

      @Get(':id')
      getUserById() {
        return 'User details by ID';
      }
    }

上記では、/users/profile と /users/:id の2つのルートが定義されています。この順序を正しく設定することが、ルーティングエラーを防ぐ鍵になります。

2. 静的パスと動的パスの違い

NestJSのルーティングでは、静的パスと動的パスを正しく理解することが重要です。

• 静的パス: 固定された文字列を含むルートです。例: /users/profile
• 動的パス: URLの一部がパラメータとして定義されているルートです。例: /users/:id

この2つのルートをどう定義するかによって、リクエストがどのメソッドにマッチするかが決まります。

3. ルーティング順序の問題とは？

NestJSでは、ルーティングは定義された順序で評価されます。そのため、静的パスと動的パスの順序を誤ると予期しない動作が発生する可能性があります。

問題の例

次のコードでは、動的パスが静的パスより先に定義されています。

    @Get(':id')
    getUserById() {
      return 'User details by ID';
    }

    @Get('profile')
    getUserProfile() {
      return 'User profile details';
    }

この場合、GET /users/profile のリクエストは :id パラメータとして解釈され、「profile」がIDとして扱われてしまいます。その結果、getUserProfile メソッドは実行されず、404エラー または予期しないレスポンスが返ることになります。

4. 正しい順序でルートを定義する方法

ルーティングの順序を正しく設定するためには、静的パスを動的パスの前に定義する必要があります。こうすることで、特定の静的ルートがまず評価され、動的ルートがそれに続くようになります。

修正後のコード例

    @Get('profile')
    getUserProfile() {
      return 'User profile details';
    }

    @Get(':id')
    getUserById() {
      return 'User details by ID';
    }

この修正により、GET /users/profile は getUserProfile メソッドにマッチし、GET /users/:id はそれ以外の動的なリクエストに対応します。

まとめ

NestJSのルーティングでは、静的パスと動的パスの順序が非常に重要です。静的パスを動的パスより先に定義することで、予期しないエラーを防ぐことができます。この記事で紹介したルーティングを参考に効果的に管理し、より安定したNestJSアプリケーションを構築しましょう。下記に実際にルーティングの問題によりエラーが起きた事例を載せておくので、参考にしてください。

*↓実際に問題が発生したケース