NestJS中GET /api/v1/admin接口未映射导致404问题排查

问题现象 #

开发http://localhost:8080/api/v1/admin GET接口时，已添加@Get注解，但接口未成功映射，调用返回404 Not Found。启动日志仅显示两个POST路由的映射记录，无GET路由信息。

排查分析 #

1. 路由映射日志验证 #

从启动日志可以看到：

[Nest] 40115  - 2022. 10. 11. 오후 4:12:15     LOG [RouterExplorer] Mapped 
{/api/v1/admin, POST} route +1ms
[Nest] 40115  - 2022. 10. 11. 오후 4:12:15     LOG [RouterExplorer] Mapped 
{/api/v1/admin/login, POST} route +1ms

仅POST路由被成功注册，GET路由未被Nest识别，说明路由注册环节出现异常。

2. 依赖注入错误 #

查看admin.module.ts的providers配置：

providers: [AdminService, TokenService],

TokenService属于TokenModule，直接在providers中声明会导致其依赖（如JwtService等）无法被正确注入，进而引发AdminService初始化异常，最终导致依赖AdminService的GET方法无法被注册。

3. 自定义装饰器与守卫潜在问题 #

• @ReqAdmin()装饰器若实现有误（如未正确使用@createParamDecorator），可能导致方法无法被识别为路由处理函数。
• HttpAuthGuard若存在语法错误或未正确实现CanActivate接口，虽不影响路由注册，但可能在请求阶段引发异常，不过当前问题核心是路由未注册，需优先排查前者。

修复方案 #

1. 修正AdminModule依赖配置 #

移除直接声明的TokenService，改为导入TokenModule，同时补充AdminRepository（若AdminService依赖该仓库）：

// admin.module.ts
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { Admin } from 'src/entities/admin.entity';
import { TokenModule } from 'src/token/token.module'; 
import { AdminController } from './admin.controller';
import { AdminRepository } from './admin.repository';
import { AdminService } from './admin.service';

@Module({
  imports: [
     TypeOrmModule.forFeature([Admin]),
     TokenModule // 导入TokenModule确保依赖完整
  ],
  providers: [AdminService, AdminRepository], // 添加AdminRepository
  exports: [AdminService],
  controllers: [AdminController]
})
export class AdminModule {}

2. 验证自定义装饰器与守卫 #

• 检查HttpAuthGuard：确保其继承CanActivate接口，且canActivate方法实现逻辑正确，无语法错误。
• 检查ReqAdmin装饰器：确保使用@createParamDecorator正确实现，例如：

  import { createParamDecorator, ExecutionContext } from '@nestjs/common';
  
  export const ReqAdmin = createParamDecorator(
    (data: unknown, ctx: ExecutionContext) => {
      const request = ctx.switchToHttp().getRequest();
      return request.admin;
    },
  );
  

3. 重新编译启动 #

删除项目根目录下的dist文件夹，执行nest start --watch重新编译项目，观察启动日志是否出现以下记录：

LOG [RouterExplorer] Mapped {/api/v1/admin, GET} route +1ms

4. 分步测试 #

• 临时注释@UseGuards(HttpAuthGuard)，直接测试GET接口是否正常返回数据。
• 确认接口可用后，重新添加守卫，验证权限逻辑是否正常。

内容的提问来源于stack exchange，提问作者user15611884