nestjs

适用场景

当用户想要执行以下操作时，请使用此技能：

• 构建或重构 NestJS 应用程序
• 实现控制器、提供者和模块
• 应用中间件、管道、守卫或拦截器
• 配置 DI 作用域、动态模块或生命周期钩子
• 添加验证、序列化、缓存、日志记录或队列
• 集成 GraphQL、WebSockets 或微服务
• 使用 OpenAPI/Swagger 编写 API 文档
• 实现身份验证/授权或加强安全性
• 为 NestJS 编写单元测试或端到端测试

如何使用此技能

1. 确定主题，根据用户的请求，在下方的映射中找到对应的示例文件

2. 从 examples/ 目录中加载相应的示例文件

3. 遵循该示例文件中有关语法、结构和最佳实践的具体说明

   重要说明：

   • 所有示例均遵循 NestJS 官方文档结构
   • 在适用的情况下，示例同时包含 JavaScript 和 TypeScript 版本
   • 每个示例文件都包含关键概念、代码示例和官方文档链接
   • 请务必查看示例文件，了解最佳实践和常见模式

4. 使用 templates/ 目录中的模板，加快常见脚手架搭建任务

文档映射（与 https://docs.nestjs.com/ 一一对应）

概览

• examples/overview/introduction.md → https://docs.nestjs.com/
• examples/fundamentals/first-steps.md → https://docs.nestjs.com/first-steps
• examples/fundamentals/controllers.md → https://docs.nestjs.com/controllers
• examples/fundamentals/providers.md → https://docs.nestjs.com/providers
• examples/fundamentals/modules.md → https://docs.nestjs.com/modules
• examples/fundamentals/middleware.md → https://docs.nestjs.com/middleware
• examples/fundamentals/exception-filters.md → https://docs.nestjs.com/exception-filters
• examples/fundamentals/pipes.md → https://docs.nestjs.com/pipes
• examples/fundamentals/guards.md → https://docs.nestjs.com/guards
• examples/fundamentals/interceptors.md → https://docs.nestjs.com/interceptors
• examples/overview/custom-decorators.md → https://docs.nestjs.com/custom-decorators

基础

• examples/fundamentals/custom-providers.md → https://docs.nestjs.com/fundamentals/custom-providers
• examples/fundamentals/async-providers.md → https://docs.nestjs.com/fundamentals/async-providers
• examples/fundamentals/dynamic-modules.md → https://docs.nestjs.com/fundamentals/dynamic-modules
• examples/fundamentals/module-ref.md → https://docs.nestjs.com/fundamentals/module-ref
• examples/fundamentals/execution-context.md → https://docs.nestjs.com/fundamentals/execution-context
• examples/fundamentals/lifecycle-events.md → https://docs.nestjs.com/fundamentals/lifecycle-events
• examples/fundamentals/injection-scopes.md → https://docs.nestjs.com/fundamentals/injection-scopes
• examples/fundamentals/request-scoped.md → https://docs.nestjs.com/fundamentals/request-scoped
• examples/fundamentals/circular-dependency.md → https://docs.nestjs.com/fundamentals/circular-dependency Techniques (技巧)
• examples/techniques/configuration.md → https://docs.nestjs.com/techniques/configuration
• examples/techniques/validation.md → https://docs.nestjs.com/techniques/validation
• examples/techniques/serialization.md → https://docs.nestjs.com/techniques/serialization
• examples/techniques/caching.md → https://docs.nestjs.com/techniques/caching
• examples/techniques/logger.md → https://docs.nestjs.com/techniques/logger
• examples/techniques/events.md → https://docs.nestjs.com/techniques/events
• examples/techniques/task-scheduling.md → https://docs.nestjs.com/techniques/task-scheduling
• examples/techniques/queues.md → https://docs.nestjs.com/techniques/queues
• examples/techniques/file-upload.md → https://docs.nestjs.com/techniques/file-upload
• examples/techniques/streaming-files.md → https://docs.nestjs.com/techniques/streaming-files
• examples/techniques/database.md → https://docs.nestjs.com/techniques/database
• examples/techniques/mongodb.md → https://docs.nestjs.com/techniques/mongodb
• examples/techniques/mongoose.md → https://docs.nestjs.com/techniques/mongoose
• examples/techniques/sequelize.md → https://docs.nestjs.com/techniques/sequelize
• examples/techniques/prisma.md → https://docs.nestjs.com/recipes/prisma

Security (安全)

• examples/security/authentication.md → https://docs.nestjs.com/security/authentication
• examples/security/authorization.md → https://docs.nestjs.com/security/authorization
• examples/security/helmet.md → https://docs.nestjs.com/security/helmet
• examples/security/cors.md → https://docs.nestjs.com/security/cors
• examples/security/rate-limiting.md → https://docs.nestjs.com/security/rate-limiting

GraphQL

• examples/graphql/quick-start.md → https://docs.nestjs.com/graphql/quick-start
• examples/graphql/resolvers.md → https://docs.nestjs.com/graphql/resolvers
• examples/graphql/scalars.md → https://docs.nestjs.com/graphql/scalars
• examples/graphql/interfaces.md → https://docs.nestjs.com/graphql/interfaces
• examples/graphql/unions.md → https://docs.nestjs.com/graphql/unions
• examples/graphql/directives.md → https://docs.nestjs.com/graphql/directives
• examples/graphql/plugins.md → https://docs.nestjs.com/graphql/plugins
• examples/graphql/subscriptions.md → https://docs.nestjs.com/graphql/subscriptions
• examples/graphql/federation.md → https://docs.nestjs.com/graphql/federation
• examples/graphql/migration.md → https://docs.nestjs.com/graphql/migration

WebSockets

• examples/websockets/gateways.md → https://docs.nestjs.com/websockets/gateways
• examples/websockets/exception-filters.md → https://docs.nestjs.com/websockets/exception-filters
• examples/websockets/guards.md → https://docs.nestjs.com/websockets/guards
• examples/websockets/interceptors.md → https://docs.nestjs.com/websockets/interceptors
• examples/websockets/adapters.md → https://docs.nestjs.com/websockets/adapters

Microservices

• examples/microservices/basics.md → https://docs.nestjs.com/microservices/basics
• examples/microservices/redis.md → https://docs.nestjs.com/microservices/redis
• examples/microservices/mqtt.md → https://docs.nestjs.com/microservices/mqtt
• examples/microservices/nats.md → https://docs.nestjs.com/microservices/nats
• examples/microservices/kafka.md → https://docs.nestjs.com/microservices/kafka
• examples/microservices/grpc.md → https://docs.nestjs.com/microservices/grpc
• examples/microservices/rabbitmq.md → https://docs.nestjs.com/microservices/rabbitmq
• examples/microservices/custom-transport.md → https://docs.nestjs.com/microservices/custom-transport
• examples/microservices/hybrid-application.md → https://docs.nestjs.com/microservices/hybrid-application

OpenAPI (Swagger)

• examples/openapi/introduction.md → https://docs.nestjs.com/openapi/introduction
• examples/openapi/operations.md → https://docs.nestjs.com/openapi/operations
• examples/openapi/types-and-parameters.md → https://docs.nestjs.com/openapi/types-and-parameters
• examples/openapi/security.md → https://docs.nestjs.com/openapi/security
• examples/openapi/mapped-types.md → https://docs.nestjs.com/openapi/mapped-types

CLI、测试与配方

• examples/cli/overview.md → https://docs.nestjs.com/cli/overview
• examples/testing/unit-testing.md → https://docs.nestjs.com/fundamentals/testing
• examples/testing/e2e-testing.md → https://docs.nestjs.com/fundamentals/testing
• examples/recipes/cqrs.md → https://docs.nestjs.com/recipes/cqrs
• examples/recipes/mikroorm.md → https://docs.nestjs.com/recipes/mikroorm
• examples/recipes/terminus.md → https://docs.nestjs.com/recipes/terminus
• examples/faq.md → https://docs.nestjs.com/faq

示例与模板

此技能包含详细示例，按照 NestJS 官方文档结构（https://docs.nestjs.com/）组织。所有示例都位于 examples/ 目录中，并按主题分类（见上方映射）。

使用示例：

• 根据用户的请求确定主题
• 从上方映射中加载相应的示例文件
• 遵循该文件中的说明、语法和最佳实践
• 根据具体用例调整代码示例

使用模板：

• 参考 templates/ 目录中的模板，进行常见的脚手架搭建
• 模板包括：控制器、提供者、模块、中间件、守卫、管道、拦截器、异常筛选器、DTO 和项目结构
• 根据具体需求和编码风格调整模板

最佳实践

1. 使用依赖注入：利用 NestJS DI 容器，提高可测试性和可维护性
2. 按模块组织：将相关功能归入功能模块
3. 一致地使用装饰器：遵循 NestJS 在控制器、提供者和路由中的装饰器模式
4. 验证输入数据：使用 ValidationPipe 和 DTO 验证请求
5. 妥善处理错误：实现全局异常筛选器，确保错误处理一致
6. 使用守卫进行授权：使用守卫保护路由，而不是内联检查
7. 充分利用拦截器：使用拦截器处理日志记录和转换等横切关注点
8. 类型安全：使用 TypeScript 提高类型安全性和开发体验
9. 全面测试：为服务编写单元测试，为 API 端点编写 E2E 测试
10. 遵循官方模式：参考官方文档，了解推荐的模式和实践

资源

• 官方文档：https://docs.nestjs.com/
• GitHub 仓库：https://github.com/nestjs/nest

关键词

NestJS、Node.js、框架、控制器、提供者、模块、中间件、异常筛选器、管道、守卫、拦截器、依赖注入、GraphQL、WebSocket、微服务、OpenAPI、Swagger、测试、验证、缓存、日志记录、TypeScript、装饰器、DI、IoC、控制器、提供者、模块、中间件、守卫、管道、拦截器、依赖注入