Appearance

路由编写规范 ​

路由闭包 ​


绝不 在路由配置文件里书写『闭包路由』或者其他业务逻辑代码 。

路由器要保持干净整洁，绝不 放置除路由配置以外的其他程序逻辑。

Restful 路由 ​


必须 优先使用 Restful 路由，配合资源控制器使用，见 文档。



超出 Restful 路由的，应该 模仿上图的方式来定义路由。

单数 or 复数？ ​


资源路由路由 URI 必须 使用复数形式，如：

  • /photos/create
  • /photos/{photo}


错误的例子如：

  • /photo/create
  • /photo/{photo}

路由命名 ​


所有路由都 必须 使用 name 方法进行命名。

必须 使用『资源前缀』作为命名规范，如下的 users.follow，资源前缀的值是 users.：

bash
# dingoapi路由写法，和标准lumen有所差异
$api->post('/users/{id}/follow', ['as' => 'users.follow',   'uses' => 'UsersController@follow']);

获取 URL ​


获取 URL 必须 遵循以下优先级：

bash
app('Dingo\Api\Routing\UrlGenerator')->version('v1')->route('users.index');