创建API路由 Creating API Endpoints

API Endpoints 这个没有办法翻译,就是route的意思,也有很多人(这个应该指老外或者装逼者),当我们在讨论APIs很多人指的意思就是the routes you visit as an endpoint

API的版本GROUP

为了避免你的主程序路由到这个包的时候采用它自己的路由,我们就必须新建一个api路由的对象

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

然后必须定义version group, 这样我们可以为不同的版本创建相同的路由,这样方便版本管理和开发
提示: 这里的$api->version可以理解为特殊的$api->group

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

如果需要一个组可以响应多个版本,这样写

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

这个group的用法和laravel自带的标准group用法一样,也可以传递数组作为第二个参数

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

});

我们的路由还可以分的在细致一点,比如version中嵌套group

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

    });

    $api->group(['middleware' => 'foo2'], function ($api) {

    });
});

关于中间件这个东西,个人还是喜欢放在每个controller中,这样感觉会更清楚点,是不是 ???

创建路由

有了上面的版本号组,现在就可以创建endpoints了,通过带有参数为$api的闭包函数,如下:

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

上面这样写好麻烦,能不能像laravel一样,在某个地方把App\Api\Controllers
放在一个命名空间下,这样写的时候,就不用写App\Api\Controllers了,

上面的问题可以这么解决(还没测试,不知道对不对):

 $api->version('v1', ['namespace' => 'Api\Controllers'], function ($api) {
    $api->get('users/{id}', 'UsersController@show');
});

//在app\api\controllers\UsersController.php中声明命名空间为Api\Controllers;

还有就是php artisan make:controller 这个命令怎么搞??

因为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');
});

从这里可以看出,dingo推荐的api的Controller的目录为

app/Api/v1/Controller

//还有
app/Api/v1/Request  (处理middleware)
app/Api/v1/Transfomers

要不要v1目录,感觉太深了???

路由别名

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

我们要生成路由的时候就可以用这个别名:

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

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

//其实感觉也没有什么卵用,直接xx->version('v1')->route('users/{id}');  不行吗??

控制台查看api 路由的命令

$ php artisan api:routes
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容