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

Laravel API版本控制文件夹结构

1 个答案: