メインコンテンツまでスキップ

コントローラー

コントローラーは、受信リクエストを処理し、クライアントにレスポンスを返す役割を担います。

コントローラーの定義

コントローラーは@Controller()デコレーターで装飾されたクラスです。デコレーターはパスプレフィックスを受け取り、コントローラー内で定義されたすべてのルートに付加されます。

import { Controller, Get, Post, pathParam, validated, response } from '@zeltjs/core';
import * as v from 'valibot';

const CreateUserBody = v.object({
name: v.string(),
email: v.pipe(v.string(), v.email()),
});

@Controller('/users')
export class UserController {
@Get('/')
findAll() {
return { users: [] };
}

@Get('/:id')
findOne(id = pathParam('id')) {
return { id, name: 'John Doe' };
}

@Post('/')
create(body = validated(CreateUserBody), res = response()) {
return res.json({ id: '1', ...body }, 201);
}
}

HTTPメソッドデコレーター

Zeltは標準的なHTTPメソッドすべてにデコレーターを提供します:

デコレーターHTTPメソッド
@Get()GET
@Post()POST
@Put()PUT
@Patch()PATCH
@Delete()DELETE
@Controller('/items')
export class ItemController {
@Get('/')
findAll() { /* ... */ }

@Get('/:id')
findOne(id = pathParam('id')) { /* ... */ }

@Post('/')
create(body = validated(schema)) { /* ... */ }

@Put('/:id')
update(id = pathParam('id'), body = validated(schema)) { /* ... */ }

@Patch('/:id')
patch(id = pathParam('id'), body = validated(schema)) { /* ... */ }

@Delete('/:id')
remove(id = pathParam('id')) { /* ... */ }
}

ルートパラメーター

pathParam()を使用してルートパラメーターを抽出します:

@Get('/:category/:id')
findOne(
category = pathParam('category'),
id = pathParam('id')
) {
return { category, id };
}

リクエストボディのバリデーション

validated()とValibotスキーマを使用してリクエストボディを検証・型付けします:

import * as v from 'valibot';

const CreatePostBody = v.object({
title: v.pipe(v.string(), v.minLength(1), v.maxLength(100)),
content: v.string(),
tags: v.optional(v.array(v.string())),
});

@Post('/')
create(body = validated(CreatePostBody)) {
// bodyは完全に型付け: { title: string; content: string; tags?: string[] }
return { id: '1', ...body };
}

バリデーションが失敗した場合、Zeltは自動的に詳細なエラー情報を含む400レスポンスを返します。

カスタムレスポンスステータス

response()を使用してHTTPステータスコードを制御します:

@Post('/')
create(body = validated(schema), res = response()) {
const created = { id: '1', ...body };
return res.json(created, 201); // 201 Createdを返す
}

@Delete('/:id')
remove(id = pathParam('id'), res = response()) {
return res.json(null, 204); // 204 No Contentを返す
}

コントローラーの登録

コントローラーはcreateHttpApp()で登録する必要があります:

import { createHttpApp } from '@zeltjs/core';
import { UserController } from './controllers/user.controller';
import { PostController } from './controllers/post.controller';

export const app = createHttpApp({
controllers: [UserController, PostController],
});

次のステップ