前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >记录Laravel 定义API 统一返回JSON响应和错误格式

记录Laravel 定义API 统一返回JSON响应和错误格式

作者头像
Alone88
发布2019-10-22 18:07:13
3.9K0
发布2019-10-22 18:07:13
举报
文章被收录于专栏:Alone88Alone88

php Laravel

最近在用 LaravelAPI 接口,记录一下统一返回JSON响应 和 返回的错误格式

因为你不设定的话,除了ajax请求会返回 json 格式,其他方式访问出现错误会重定向到 /login 或者 /home

下面教你简单设置 首先响应格式 和统一返回错误提示

第一步编写 BaseRequest

代码语言:javascript
复制
<?php

namespace App\Http\Requests;

use Illuminate\Contracts\Validation\Validator;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Http\Exceptions\HttpResponseException;

class BaseRequest extends FormRequest
{
    // 定义统一的返回错误格式,下面的可以不定义
    protected function failedValidation(Validator $validator)
    {
      throw(new HttpResponseException(response()->json([
          'code'=>422,
          'msg'=>$validator->errors(),
          'data'=>null
      ],422)));
    }


    // 是否所有response 都是JSON 返回
    public function expectsJson()
    {
        return true;
    }
    public function wantsJson()
    {
        return true;
    }
}

第二部 替换BaseRequest

在 public/index.php 文件中,将 IllumiateHttpRequest 替换为我们的 BaseRequest,如下:

代码语言:javascript
复制
$response = $kernel->handle(
    $request = \App\Http\Requests\BaseRequest::capture()
);

本文由 Alone88 创作,采用 知识共享署名4.0 国际许可协议进行许可 本站文章除注明转载/出处外,均为本站原创或翻译,转载前请务必署名 最后编辑时间为: Sep 20, 2019 at 03:58 pm

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 第一步编写 BaseRequest
  • 第二部 替换BaseRequest
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档