Laravel API版本控制文件夹结构

Question

我是api版本控制的新手，所以我的问题是：

1）此文件夹结构是否正确？

/app
  /controllers
    /Api
      /v1
        /UserController.php
      /v2
        /UserController.php

路线：

Route::group(['prefix' => 'v1'], function () {
  Route::get('user',      'Api\v1\UserController@index');
  Route::get('user/{id}', 'Api\v1\UserController@show');
});

Route::group(['prefix' => 'v2'], function () {
  Route::get('user',      'Api\v2\UserController@index');
  Route::get('user/{id}', 'Api\v2\UserController@show');
});

2）关于模型和事件的文件夹结构如何，我应该为每个版本制作模型吗？

Answer 1

您的方法对于API版本控制是正确的。为了避免Api\vN\在每个控制器路径之前重复前缀，您还可以执行以下操作：

Route::group(['prefix' => 'api/v1', 'namespace' => 'Api\v1'], function () {
  Route::get('user',      'UserController@index');
  Route::get('user/{id}', 'UserController@show');
});

Route::group(['prefix' => 'api/v2', 'namespace' => 'Api\v2'], function () {
  Route::get('user',      'UserController@index');
  Route::get('user/{id}', 'UserController@show');
});

如果您不想自己管理它，则还可以使用一些支持版本控制的API库。我成功使用过Dingo多次，但可能还有更多可用的方式。

我不认为您应该版本模型。它们应该代表您当前的数据库结构，因此是唯一的。如果需要进行一些更改，请尝试使其与仍在维护的API版本向后兼容。

这些事件的故事相同，除非它们与您的API紧密关联。在那种情况下，我认为最佳的文件夹结构应与控制器相同：

/app
  /Events
    /Api
      /v1
        /ApiEvent.php
      /v2
        /ApiEvent.php
    GenericEvent.php