Laravel & Lumen RESTFul API 扩展包:Dingo API(二) —— 创建 API Endpoint(路由)

Endpoint 就是路由的另一种术语,当我们讨论API时,很多人习惯将访问的路由看作Endpoint。

1、版本号

为了避免和主应用的路由混在一起,Dingo API使用了自己的路由器,正因如此我们首先需要获取API路由器实例来创建Endpoint:

$api = app('Dingo\Api\Routing\Router');

接下来需要定义版本号,从而可以为多版本API创建同样的Endpoint以便后续回滚:

$api->version('v1', function ($api) {

});

如果你想要某个组响应多个版本的API可以传递多版本数组:

$api->version(['v1', 'v2'], function ($api) {

});

这里的版本号可以看作和框架的标准路由分组一样传递数组属性作为第二个参数:

$api->version('v1', ['middleware' => 'foo'], function ($api) {

});

还可以嵌套普通版分组以便后续实现更复杂的自定义Endpoint:

$api->version('v1', function ($api) {
    $api->group(['middleware' => 'foo'], function ($api) {
        // Endpoints registered here will have the "foo" middleware applied.
    });
});

2、创建Endpoint

有了版本号之后就可以开始使用$api创建Endpoint了:

$api->version('v1', function ($api) {
    $api->get('users/{id}', 'App\Api\Controllers\UserController@show');
});

因为Endpoint以版本号进行分组,所以你可以使用同样的URI为同一Endpoint创建不同的响应:

$api->version('v1', function ($api) {
    $api->get('users/{id}', 'App\Api\V1\Controllers\UserController@show');
});

$api->version('v2', function ($api) {
    $api->get('users/{id}', 'App\Api\V2\Controllers\UserController@show');
});

还可以使用各自的方法注册资源和控制器。

注意:与Laravel不同,这里必须指定控制器的完整命名空间。

命名路由并生成URL

命名路由可以帮助我们轻松生成对应URL。你可以像在Laravel中一样命名路由:

$api->get('users/{id}', ['as' => 'users.index', 'uses' => 'Api\V1\UserController@show']);

然后你可以生成URL到这个命名路由:

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

必须提供一个版本号以便URL可以基于该版本号生成,同时,你可以在不同版本号中使用同一个命名路由。

3、在控制台查看路由

如果你使用的是Laravel 5.1,可以使用Artisan命令查看注册路由:

$ php artisan api:routes

该命令和Laravel中的route:list命令一样。

学院君 has written 976 articles

Laravel学院院长,终身学习者

积分:111887 等级:P12 职业:手艺人 城市:杭州

9 条回复

  1. Dsir Dsir says:
    您好,我遇到了一个问题希望得到您的解答~ 我的项目用的DingoApi 配置的.env文件里面的的 API_STRICT=false API_VERSION=V1 routes.php里面$api->version("v1", ['namespace' => 'App\Http\Controllers\V1'], function() use ($api) { }); 指定v1,如上面代码所示。两个配置的大小写不一致。 现在的问题是。 1).这两个值不一样的时候,浏览器会在我不添加header时提示致命错误,错误信息是:Fatal error: Call to a member function requestIsConditional() on null in。当我加上Header的Accept后不报错正常访问。 2).而如果这两个值一样,那么不论我加不加Header的accept都能正常访问。 不知道您知道这是为什么吗?
  2. Alonexy Alonexy says:
    @ 乐哥 foreach(File::allFiles(__DIR__.'/routes') as $partial){ require_once $partial->getPathname();}
  3. study study says:
    这里的v1,v2版本信息,是怎样传递过来的?
  4. lookas2001 lookas2001 says:
    @ 梦 那,学院君,这个独立文件应该放在哪里?另外,有相关的项目案例可以参考一下吗?
  5. 小资情调精品推荐 小资情调精品推荐 says:
    请问下,lumen怎么查看 api:routs?
  6. 单简 单简 says:
    想问问在api中使用session的问题?
  7. 老菜 老菜 says:
    Dingo Api的路由规则应该写在哪个文件,还是routes.php吗?

登录后才能进行评论,立即登录?