Router module

Trong một ứng dụng HTTP (ví dụ: REST API), route path của một hàm xử lý (route handler) được xác định bằng cách nối prefix (không bắt buộc) khai báo cho controller (bên trong decorator @Controller), với path được chỉ định trong decorator của method (ví dụ: @Get('users')). Bạn có thể tìm hiểu thêm về điều này trong phần này. Ngoài ra, bạn có thể định nghĩa một prefix toàn cục cho tất cả các route đăng ký trong ứng dụng, hoặc bật versioning.

Bên cạnh đó, có những trường hợp đặc biệt mà việc định nghĩa prefix ở cấp module (và do đó áp dụng cho tất cả controller đăng ký bên trong module đó) sẽ rất hữu ích. Ví dụ, hãy tưởng tượng một ứng dụng REST expose nhiều endpoint khác nhau được dùng bởi một phần cụ thể trong ứng dụng của bạn gọi là “Dashboard”. Trong trường hợp này, thay vì lặp lại prefix /dashboard trong từng controller, bạn có thể dùng module tiện ích RouterModule, như sau:

@Module({
  imports: [
    DashboardModule,
    RouterModule.register([
      {
        path: 'dashboard',
        module: DashboardModule,
      },
    ]),
  ],
})
export class AppModule {}

Ngoài ra, bạn có thể định nghĩa cấu trúc phân cấp. Nghĩa là mỗi module có thể có các module children (module con). Các module con sẽ kế thừa prefix của module cha. Trong ví dụ dưới đây, chúng ta sẽ đăng ký AdminModule làm module cha của DashboardModule và MetricsModule.

@Module({
  imports: [
    AdminModule,
    DashboardModule,
    MetricsModule,
    RouterModule.register([
      {
        path: 'admin',
        module: AdminModule,
        children: [
          {
            path: 'dashboard',
            module: DashboardModule,
          },
          {
            path: 'metrics',
            module: MetricsModule,
          },
        ],
      },
    ])
  ],
});

Trong ví dụ trên, bất kỳ controller nào đăng ký bên trong DashboardModule sẽ có thêm prefix /admin/dashboard (vì module nối các path từ trên xuống dưới - một cách đệ quy - từ cha đến con). Tương tự, mỗi controller định nghĩa bên trong MetricsModule sẽ có thêm prefix cấp module /admin/metrics.