dingo for laravel 入门

它的中文文档地址：https://laravel-china.org/docs/dingo-api/2.0.0

简介
dingo是针对laravel、lumen框架的api开发工具包。
粗看文档目录，基于api规范，它围绕了三个主要功能：
1路由版本管理
2Http Exception 异常处理
3Response Transform 转化响应格式
下面围绕文档简略介绍自己对路由版本部分的总结，作为入门的参考文章。

路由版本控制

一、相关配置

---

1声明api服务
api规范要求，接口开发要么带api前缀（http://XXX.com/api/xxx），要么是子域名（http://api.XXX.com/xxx），通过这样的标识，代表请求的是api接口服务。

所以，API_PREFIX=api和API_DOMAIN=api.myapp.com须设置其中一个。

.env可能需要配置的选项

当然它的作用并非只是个标识，我们知道dingo的路由与laravel的路由是共存的，dingo便是通过这个特征来判断的。

---

2版本控制
dingo提供了自己的路由服务，如果http://XXX.com/api/xxx或http://api.XXX.com/xxx访问，它则认为是api请求，dingo路由服务Dingo\Api\Routing\Router会接管laravel自带的路由服务Illuminate\Routing\Router（至于是如何接管的，之后再说），它同样有get(),post(),match(),group()…方法，相当于另一套路由体系。

laravel区分版本的话，可能需要带上一个v1前缀，例如http://XXX.com/api/v1或者http://XXX.com/api/v2。而dingo是通过 header头Accept处理的。它的格式是Accept: application/vnd.YOUR_SUBTYPE.v1+json。意味着你需要发送一个accept的请求头才能访问。

配置文件中，默认这种模式是不强制的，API_STRICT=false，但只能访问配置文件中默认的版本，'version' => env('API_VERSION', 'v1'),。
如果设置为true，即开启严格模式，则必须发送accept头，不能通过浏览器直接访问你的 API。

.env可能需要配置的选项
API_STRICT=true //开启严格模式必须不论v1,v2都须带上accept头信息
API_VERSION=v1 //在没有声明版本号时的默认版本号

若开启严格模式
关于header头的accept属性几个选项：
Accept: application/vnd.YOUR_SUBTYPE.v1+json
API_STANDARDS_TREE=x,prs,vnd Standards Tree 标准树
API_SUBTYPE=myapp 子类型:程序或项目的短名称
v1：版本号
json：返回的格式，也可以为jsonp

.env可能需要配置的选项
API_STANDARDS_TREE=prs
API_SUBTYPE=lara
API_DEFAULT_FORMAT=json //默认

以上大概就是版本控制的相关配置。

二、版本控制的具体实现

一个端点也就是一个路由。
创建路由

---

//laravel路由
Route::resource('home','StudentController');

//dingo路由
$api = app('Dingo\Api\Routing\Router');

$api->version('v1', ['middleware'=>'auth.api'], function ($api) {
	$api->get('demo', 'App\Http\Controllers\Api\V1\DemoController@index');
});

$api->version('v2', function ($api) {
	$api->get('demo', 'App\Http\Controllers\Api\V2\DemoController@index');
});

v1/demo我使用了验证登陆的中间件。

---

请求v1/demo

当我打开严格模式时


由于严格的匹配过程，无法正确解析Accept标头

---

请求v2/demo 这次带上accept