欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Laravel+Dingo/Api 自定义响应的实现

程序员文章站 2023-11-25 17:18:10
在最近的开发开发项目中,我使用了dingo/api这个第三方api库。 dingo是个很强大的api库, 但在开发的过程中,需要自定义响应字段。 刚开始使用ding...

在最近的开发开发项目中,我使用了dingo/api这个第三方api库。

dingo是个很强大的api库, 但在开发的过程中,需要自定义响应字段。

刚开始使用ding/api时,返回如下:

{
  "message": "422 unprocessable entity",
  "errors": {
    "mobile": [
      "手机号格式不正确"
    ]
  },
  "status_code": 422
}

这是输入字段验证错误时,dingo返回的结果。

这样看上去没什么问题。因为这边 status_code 是比较规范的。对于 php 来说,直接 json_decode 之后,并没有什么难办的地方。但是对面安卓和 ios 则是使用的强类型语言。尤其是 java,需要对每一个 json 对象进行新建,然后序列化。所以,这种格式不统一的返回结果,是无法接受的

解决方法: 我们需要将所有的异常信息归总到一个地方,在appserviceprovider的boot()方法中添加

// 将所有的 exception 全部交给 app\exceptions\handler 来处理
app('api.exception')->register(function (exception $exception) {
  $request = illuminate\http\request::capture();
  return app('app\exceptions\handler')->render($request, $exception);
}); 

然后在app\exceptions\handler.php中的render()方法中:

$class = get_class($exception);
switch ($class) {
  case 'dingo\api\exception\validationhttpexception':
    if ($request->expectsjson())
      return $this->errorrespond($exception->geterrors()->first(), $exception->getstatuscode());
    break;

  default:
    if ($request->expectsjson())
      return $this->errorrespond('系统休息了', 500000);

    break;
}

再次访问接口:

{
  "response_status_code": 422,
  "response_message": "请填写手机号",
  "data": []
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。