laravel中使用ApiController统一返回的数据格式

最新推荐文章于 2024-03-01 14:34:33 发布

原创

最新推荐文章于 2024-03-01 14:34:33 发布 · 1.2k 阅读

3 ·

CC 4.0 BY-SA版权

本文介绍如何通过创建Api 控制器，如ApiController，统一处理接口返回，包括成功和错误响应，并演示了parseNull方法的作用，提升API兼容性。

laravel 在Api接口开发中，可以使用 response()->json(["code"=>200,"msg"=>"ok","data"=>$data]);返回接口的json数据但是太过烦索我的解决方法如下，创一个 ApiController 继承 Controller然后，所有的 api中的控制器都继承ApiController；在ApiController 写上一些公用的方法

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;

class ApiController extends Controller
{
    /**
     * 成功返回.
     *
     * @param array  $data
     * @param string $msg
     *
     * @return mixed
     */
    public function success($data, $msg = "OK")
    {
        $this->parseNull($data);
        $result = [
            "code" => 200,
            "msg" => $msg,
            "data" => $data,
        ];

        return response()->json($result, 200);
    }

    /**
     * 失败返回.
     *
     * @param string $code
     * @param array  $data
     * @param string $msg
     *
     * @return mixed
     */
    public function error($code = "422", $data = [], $msg = "fail")
    {
        $result = [
            "cod