Laravel框架下一对一关联的API路由设计规范咨询

结论 #

一对一关联场景下，直接使用/api/scenarios/1/user的路由定义更合理，不需要额外携带子资源ID。

设计逻辑说明 #

• 嵌套路由的核心作用是通过父资源限定子资源的查询范围：
  一对多关联中，单个父资源对应多个子资源，所以需要额外传入子资源ID才能定位到唯一记录，/api/scenarios/1/users/1的写法是符合这个逻辑的。
  而一对一关联的特性就是单个父资源最多只能对应一个子资源，只要传入父资源IDscenarios/1就可以唯一锁定对应的user记录，再追加子资源ID完全是多余的。
• 写法/api/scenarios/1/user/1反而会引入不必要的问题：你需要额外做校验逻辑，确认URL里传入的user ID确实和当前scenario关联，平白增加开发成本，还容易产生参数冲突的BUG。

Laravel实现参考 #

路由定义 #

// 获取关联的user
Route::get('/scenarios/{scenario}/user', [ScenarioController::class, 'showUser']);
// 更新关联的user
Route::put('/scenarios/{scenario}/user', [ScenarioController::class, 'updateUser']);
// 删除关联的user
Route::delete('/scenarios/{scenario}/user', [ScenarioController::class, 'deleteUser']);

控制器逻辑示例 #

public function showUser(Scenario $scenario)
{
    // 关联不存在直接返回404，符合RESTful规范
    return response()->json($scenario->userOrFail());
}

内容的提问来源于stack exchange，提问作者NicuVlad