您好,欢迎访问一九零五行业门户网

Laravel & Lumen RESTFul API 扩展包:Dingo API(三) -- Response(响应)

一个api的功能主要是获取请求并返回响应给客户端,响应的格式是多样的,比如json,返回响应的方式也是多样的,这取决于当前构建的api的复杂度以及对未来的考量。
返回响应最简单的方式是直接从控制器返回数组或对象,但不是每个响应对象都能保证格式正确,所以你要确保它们实现了 arrayobject或者 illuminate\support\contracts\arrayableinterface接口:
class usercontroller{ public function index() { return user::all(); }}
在本例中, user类继承自 illuminate\database\eloquent\model,这意味着返回的是可以被格式化为数组的数据,当然也可以返回单个用户:
class usercontroller{ public function show($id) { return user::findorfail($id); }}
dingo api会自动将响应格式化为json格式并设置 content-type头为 application/json。
1、响应构建器 响应构建器提供了平滑的接口以便我们轻松构建更多自定义的响应。响应构建器通常与转换器(transformer)一起使用。
要使用响应构建器控制器需要使用 dingo\api\routing\helperstrait,为了让每个控制器都可以使用这个trait,我们将其放置在api基类控制器 controller中:
use dingo\api\routing\helpers;use illuminate\routing\controller;class basecontroller extends controller{ use helpers;}
现在可以定义一个继承自该控制器的控制器,在这些控制器中可以通过 $response属性来访问响应构建器。
数组响应 class usercontroller extends basecontroller{ public function show($id) { $user = user::findorfail($id); return $this->response->array($user->toarray()); }}
单个item响应 class usercontroller extends basecontroller{ public function show($id) { $user = user::findorfail($id); return $this->response->item($user, new usertransformer); }}
集合响应 class usercontroller extends basecontroller{ public function index() { $users = user::all(); return $this->response->collection($users, new usertransformer); }}
分页响应 class usercontroller extends basecontroller{ public function index() { $users = user::paginate(25); return $this->response->paginator($users, new usertransformer); }}
无内容响应 return $this->response->nocontent();
创建响应 return $this->response->created();
还可以将位置信息作为创建资源的第一个参数:
return $this->response->created($location);
错误响应 你可以使用多种内置错误生成错误响应:
// a generic error with custom message and status code.return $this->response->error('this is an error.', 404);// a not found error with an optional message as the first parameter.return $this->response->errornotfound();// a bad request error with an optional message as the first parameter.return $this->response->errorbadrequest();// a forbidden error with an optional message as the first parameter.return $this->response->errorforbidden();// an internal error with an optional message as the first parameter.return $this->response->errorinternal();// an unauthorized error with an optional message as the first parameter.return $this->response->errorunauthorized();
添加额外的响应头 使用了上述方法之后还可以通过添加响应头来自定义响应:
return $this->response->item($user, new usertransformer)->withheader('x-foo', 'bar');
添加元数据 某些转化层可能会使用元数据(meta data),这在你需要提供额外与资源关联的数据时很有用:
return $this->response->item($user, new usertransformer)->addmeta('foo', 'bar');
还可以设置元数据数组替代多个方法链的调用:
return $this->response->item($user, new usertransformer)->setmeta($meta);
设置响应状态码 return $this->response->item($user, new usertransformer)->setstatuscode(200);
2、自定义响应格式 在安装配置中我们已经简单接触过响应格式,默认情况下dingo api会自动使用json格式并设置相应的 content-type头。除了json之外还有一个jsonp格式,改格式会将响应封装到一个回调中。要注册改格式只需要简单将配置文件(laravel)或启动文件(lumen)中的默认json格式替换成jsonp即可:
'formats' => [ 'json' => 'dingo\api\http\response\format\jsonp']
或者:
dingo\api\http\response::addformatter('json', new dingo\api\http\response\format\jsonp);
默认情况下回调参数默认查询字符串是callback,这可以通过修改构造函数的第一个参数来设置。如果查询字符串不包含任何参数将会返回json响应。
你还可以注册并使用自己需要的响应格式,自定义的格式对象需要继承自 dingo\api\http\response\format\format类,同时还要实现如下这些方法: formateloquentmodel, formateloquentcollection, formatarray以及 getcontenttype。
3、morphing 和 morphed事件 在dingo api发送响应之前会先对该响应进行转化(morph),这个过程包括运行所有转换器(transformer)以及通过配置的响应格式发送响应。如果你需要控制响应如何被转化可以使用 responsewasmorphed和 responseismorphing事件。
我们在 app/listeners中为事件创建监听器:
use dingo\api\event\responsewasmorphed;class addpaginationlinkstoresponse{ public function handle(responsewasmorphed $event) { if (isset($event->content['meta']['pagination'])) { $links = $event->content['meta']['pagination']['links']; $event->response->headers->set( 'link', sprintf('; rel=next, ; rel=prev', $links['links']['next'], $links['links']['previous']) ); } }}
然后通过在 eventserviceprovider中注册事件及其对应监听器来监听该事件:
protected $listen = [ 'dingo\api\event\responsewasmorphed' => [ 'app\listeners\addpaginationlinkstoresponse' ]];
现在所有包含分页链接的响应也会将这些链接添加到 link头。
注意:目前该功能还在开发阶段,不建议用于生产环境。
其它类似信息

推荐信息