ルートグループは、複数の関連するエンドポイントをグループ化し、ルーティングの管理を簡素化するために使用されます。例えば、あなたがAPIを構築している場合、異なるエンドポイントを異なるルートグループにまとめることができます。これにより、コードの整理や保守性の向上が可能になります。
以下に、ルートグループの使用方法とコード例を示します。まず、フレームワークやライブラリによって異なる構文がある場合があるため、使用しているフレームワークに合わせた記述方法を確認してください。
- Express.jsを使用した場合のコード例:
const express = require('express');
const app = express();
const usersRouter = require('./routes/users');
const productsRouter = require('./routes/products');
// ルートグループの作成
const apiRouter = express.Router();
// ルートグループにエンドポイントを追加
apiRouter.use('/users', usersRouter);
apiRouter.use('/products', productsRouter);
// ルートグループをアプリケーションにマウント
app.use('/api', apiRouter);
// サーバーの起動
app.listen(3000, () => {
console.log('サーバーが起動しました。');
});上記の例では、/api というパスにルートグループをマウントしています。ルートグループ内のエンドポイントは、それぞれ /users と /products というパスでアクセスできます。
- Laravelを使用した場合のコード例:
use App\Http\Controllers\UsersController;
use App\Http\Controllers\ProductsController;
// ルートグループの作成
Route::prefix('api')->group(function () {
// ルートグループにエンドポイントを追加
Route::prefix('users')->group(function () {
Route::get('/', [UsersController::class, 'index']);
Route::post('/', [UsersController::class, 'store']);
});
Route::prefix('products')->group(function () {
Route::get('/', [ProductsController::class, 'index']);
Route::post('/', [ProductsController::class, 'store']);
});
});上記の例では、/api というパスにルートグループを作成し、その中に /users と /products のエンドポイントを定義しています。
以上が、ルートグループの使用方法とコード例の一部です。フレームワークやライブラリによって異なる実装方法があるため、詳細な使用方法は各ドキュメントを参照してください。ルートグループを使用することで、コードの整理や保守性の向上が期待できます。