🛣️ カテゴリルートブロック
カテゴリルートブロックは、Nodeblocksアプリケーションにおけるカテゴリ管理操作のための事前設定されたHTTPエンドポイントを提供します。これらのルートは、適切な認証、認可、エラー処理による完全なAPIエンドポイントを作成するために、ハンドラー、バリデーター、ミドルウェアを組み合わせます。
🎯 概要
カテゴリルートブロックは以下を目的として設計されています：
- カテゴリ管理操作のための完全なAPIエンドポイントの提供
- 安全な操作のためのハンドラーとバリデーターの組み合わせ
- 認証と認可チェックの実装
- 階層的カテゴリ管理のサポート
- カテゴリステータス制御（有効/無効）の実現
📋 ルート構造
各カテゴリルートは一貫したパターンに従います：
- HTTPメソッド: 操作タイプの定義（GET、POST、PUT、DELETE）
- パス: パラメータ付きエンドポイントURLの指定
- ハンドラー: ビジネスロジックのためのコンポーズド関数チェーン
- バリデーター: 認証と認可のチェック
🔧 利用可能なカテゴリルート
createCategoryRoute
POST /categoriesによる新しいカテゴリを作成します。
目的: 階層サポート付きカテゴリ作成を処理
ルート詳細:
- メソッド:
POST - パス:
/categories - 認証: 必要（Bearerトークン）
使用方法:
import { routes } from '@nodeblocks/backend-sdk';
// Expressアプリでルートを登録
app.use('/api', routes.createCategoryRoute);
getCategoryRoute
GET /categories/:categoryIdによるIDで特定のカテゴリを取得します。
目的: カテゴリデータを取得
ルート詳細:
- メソッド:
GET - パス:
/categories/:categoryId - 認証: 不要
使用方法:
import { routes } from '@nodeblocks/backend-sdk';
// Expressアプリでルートを登録
app.use('/api', routes.getCategoryRoute);
findCategoriesRoute
GET /categoriesによるすべてのカテゴリを取得します。
目的: ページネーションと階層サポート付きカテゴリをリスト
ルート詳細:
- メソッド:
GET - パス:
/categories - 認証: 不要
使用方法:
import { routes } from '@nodeblocks/backend-sdk';
// Expressアプリでルートを登録
app.use('/api', routes.findCategoriesRoute);
updateCategoryRoute
PUT /categories/:categoryIdによるカテゴリを更新します。
目的: カテゴリデータを変更
ルート詳細:
- メソッド:
PUT - パス:
/categories/:categoryId - 認証: 必要（Bearerトークン）
使用方法:
import { routes } from '@nodeblocks/backend-sdk';
// Expressアプリでルートを登録
app.use('/api', routes.updateCategoryRoute);
enableCategoryRoute
PUT /categories/:categoryId/enableによるカテゴリを有効化します。
目的: カテゴリステータスを有効に設定
ルート詳細:
- メソッド:
PUT - パス:
/categories/:categoryId/enable - 認証: 必要（Bearerトークン）
使用方法:
import { routes } from '@nodeblocks/backend-sdk';
// Expressアプリでルートを登録
app.use('/api', routes.enableCategoryRoute);
disableCategoryRoute
PUT /categories/:categoryId/disableによるカテゴリを無効化します。
目的: カテゴリステータスを無効に設定
ルート詳細:
- メソッド:
PUT - パス:
/categories/:categoryId/disable - 認証: 必要（Bearerトークン）
使用方法:
import { routes } from '@nodeblocks/backend-sdk';
// Expressアプリでルートを登録
app.use('/api', routes.disableCategoryRoute);
deleteCategoryRoute
DELETE /categories/:categoryIdによるカテゴリを削除します。
目的: 階層クリーンアップ付きカテゴリを削除
ルート詳細:
- メソッド:
DELETE - パス:
/categories/:categoryId - 認証: 必要（Bearerトークン）
使用方法:
import { routes } from '@nodeblocks/backend-sdk';
// Expressアプリでルートを登録
app.use('/api', routes.deleteCategoryRoute);
🔗 関連ドキュメント
- カテゴリスキーマブロック - カテゴリデータ検証と契約
- カテゴリハンドラーブロック - カテゴリビジネスロジック機能
- カテゴリフィーチャーブロック - カテゴリコンポーズド機能