nestjs について
NestJS と TypeScript による Node.js アプリケーション構築を支援する学習・リファレンススキルです。アプリ構成や一般的なバックエンドの設計から、CRUD、マイクロサービス、テストまでを扱います。
主な機能
- 01モジュール、コントローラー、サービス
- 02依存性注入のパターン
- 03DTO バリデーションとガード
- 04データベースと認証のパターン
- 05マイクロサービス、GraphQL、WebSockets
- 06トラブルシューティングとテストテンプレート
活用シーン
- 01NestJS バックエンドの構成
- 02バリデーションと認証の追加
- 03マイクロサービスのパターン学習
- 04サービスの単体テスト作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ pluginagentmarketplace/ custom-plugin-nodejs --skill nestjsインストール後、Claude Code で/nestjsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
assets/config.yamlschema.jsonreferences/GUIDE.mdPATTERNS.mdscripts/validate.py詳細
NestJS フレームワークスキル
TypeScript、依存性注入、エンタープライズ向けパターンを活用して、スケーラブルで保守しやすい Node.js アプリケーションを構築するための NestJS を習得します。
クイックスタート
NestJS アプリを 4 つのステップで作成します。
- プロジェクトを作成 -
nest new project-name - モジュールを定義 - 機能を整理します
- コントローラーを追加 - リクエストを処理します
- サービスを作成 - ビジネスロジックを実装します
コアコンセプト
モジュール構造
// users/users.module.ts
import { Module } from '@nestjs/common';
import { UsersController } from './users.controller';
import { UsersService } from './users.service';
import { TypeOrmModule } from '@nestjs/typeorm';
import { User } from './entities/user.entity';
@Module({
imports: [TypeOrmModule.forFeature([User])],
controllers: [UsersController],
providers: [UsersService],
exports: [UsersService] // Make available to other modules
})
export class UsersModule {}
コントローラー
// users/users.controller.ts
import { Controller, Get, Post, Body, Param, Query, UseGuards } from '@nestjs/common';
import { UsersService } from './users.service';
import { CreateUserDto } from './dto/create-user.dto';
import { JwtAuthGuard } from '../auth/guards/jwt-auth.guard';
import { ApiTags, ApiOperation, ApiBearerAuth } from '@nestjs/swagger';
@ApiTags('users')
@Controller('users')
export class UsersController {
constructor(private readonly usersService: UsersService) {}
@Get()
@ApiOperation({ summary: 'Get all users' })
findAll(@Query('page') page = 1, @Query('limit') limit = 10) {
return this.usersService.findAll(page, limit);
}
@Get(':id')
findOne(@Param('id') id: string) {
return this.usersService.findOne(id);
}
@Post()
@UseGuards(JwtAuthGuard)
@ApiBearerAuth()
create(@Body() createUserDto: CreateUserDto) {
return this.usersService.create(createUserDto);
}
}
依存性注入を使用したサービス
// users/users.service.ts
import { Injectable, NotFoundException } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { User } from './entities/user.entity';
@Injectable()
export class UsersService {
constructor(
@InjectRepository(User)
private usersRepository: Repository<User>
) {}
async findAll(page: number, limit: number) {
const [users, total] = await this.usersRepository.findAndCount({
skip: (page - 1) * limit,
take: limit
});
return { data: users, total, page, limit };
}
async findOne(id: string): Promise<User> {
const user = await this.usersRepository.findOne({ where: { id } });
if (!user) {
throw new NotFoundException(`User #${id} not found`);
}
return user;
}
async create(createUserDto: CreateUserDto): Promise<User> {
const user = this.usersRepository.create(createUserDto);
return this.usersRepository.save(user);
}
}
学習パス
初級(2~3 週間)
- ✅ NestJS CLI とプロジェクト構造
- ✅ モジュール、コントローラー、サービス
- ✅ 依存性注入の基礎
- ✅ 基本的な CRUD 操作
中級(4~6 週間)
- ✅ ガード、パイプ、インターセプター
- ✅ TypeORM/Prisma との統合
- ✅ JWT 認証
- ✅ class-validator によるバリデーション
上級(8~12 週間)
- ✅ トランスポートを利用したマイクロサービス
- ✅ NestJS による GraphQL
- ✅ WebSocket(ゲートウェイ)
- ✅ テスト戦略
DTO によるバリデーション
// dto/create-user.dto.ts
import { IsEmail, IsString, MinLength, IsOptional } from 'class-validator';
import { ApiProperty } from '@nestjs/swagger';
export class CreateUserDto {
@ApiProperty({ example: '[email protected]' })
@IsEmail()
email: string;
@ApiProperty({ example: 'John Doe' })
@IsString()
@MinLength(2)
name: string;
@ApiProperty({ example: 'password123' })
@IsString()
@MinLength(8)
password: string;
@ApiProperty({ required: false })
@IsOptional()
@IsString()
avatar?: string;
}
認証用ガード
// auth/guards/jwt-auth.guard.ts
import { Injectable, ExecutionContext } from '@nestjs/common';
import { AuthGuard } from '@nestjs/passport';
@Injectable()
export class JwtAuthGuard extends AuthGuard('jwt') {
canActivate(context: ExecutionContext) {
return super.canActivate(context);
}
}
// auth/guards/roles.guard.ts
import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
@Injectable()
export class RolesGuard implements CanActivate {
constructor(private reflector: Reflector) {}
canActivate(context: ExecutionContext): boolean {
const requiredRoles = this.reflector.get<string[]>('roles', context.getHandler());
if (!requiredRoles) return true;
const { user } = context.switchToHttp().getRequest();
return requiredRoles.some(role => user.roles?.includes(role));
}
}
例外フィルター
// filters/http-exception.filter.ts
import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
import { Response } from 'express';
@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
catch(exception: HttpException, host: ArgumentsHost) {
const ctx = host.switchToHttp();
const response = ctx.getResponse<Response>();
const status = exception.getStatus();
response.status(status).json({
success: false,
statusCode: status,
message: exception.message,
timestamp: new Date().toISOString()
});
}
}
マイクロサービスのトランスポート
// main.ts for microservice
import { NestFactory } from '@nestjs/core';
import { Transport, MicroserviceOptions } from '@nestjs/microservices';
const app = await NestFactory.createMicroservice<MicroserviceOptions>(
AppModule,
{
transport: Transport.RMQ,
options: {
urls: ['amqp://localhost:5672'],
queue: 'orders_queue',
queueOptions: { durable: true }
}
}
);
await app.listen();
単体テストのテンプレート
describe('UsersService', () => {
let service: UsersService;
let repository: Repository<User>;
beforeEach(async () => {
const module = await Test.createTestingModule({
providers: [
UsersService,
{
provide: getRepositoryToken(User),
useValue: {
findOne: jest.fn(),
create: jest.fn(),
save: jest.fn()
}
}
]
}).compile();
service = module.get<UsersService>(UsersService);
repository = module.get<Repository<User>>(getRepositoryToken(User));
});
it('should find user by id', async () => {
const user = { id: '1', name: 'John' };
jest.spyOn(repository, 'findOne').mockResolvedValue(user as User);
expect(await service.findOne('1')).toEqual(user);
});
});
トラブルシューティング
| 問題 | 原因 | 解決方法 |
|---|---|---|
| 循環依存 | モジュールのインポート | forwardRef() を使用します |
| インジェクショントークンが見つからない | プロバイダーの不足 | モジュールの providers に追加します |
| バリデーションが機能しない | パイプの不足 | ValidationPipe をグローバルに追加します |
| ガードが実行されない | 順序が間違っている | @UseGuards を正しく使用します |
使用する場面
次の場合に NestJS を使用します。
- エンタープライズ向け Node.js アプリケーションを構築する場合
- 強い型付けを備えた TypeScript が必要な場合
- 依存性注入を利用したい場合
- マイクロサービスを構築する場合
- OpenAPI ドキュメントが必要な場合
関連スキル
- Express REST API(基盤となるフレームワーク)
- TypeScript(言語)
- GraphQL(REST の代替)
- マイクロサービス(分散システム)
リソース
コメント
Markdown 対応