问一下大家,laravel怎么在api接口输出的时候多包一层data?谢谢~

我是这样子写的。

//失败返回
    public function error($code=422,$data="",$msg="fail"){
        $result = [
            "code"=>$code,
            "message"=>$msg,
            "data"=>$data
        ];
        return response()->json($result,200);
    }

想要什么格式都可以自定义的。

分页的可以是这样

public function success_list($data,$msg="成功" ,$total=0,$page=1,$limit=15){
        $result = [
            "code"=>200,
            "message"=>$msg,
            "data"=>[
                'total'=>$total,
                'page'=>$page,
                'limit'=>$limit,
                'data'=>$data
            ]
        ];
        return response()->json($result,200);
    }

API 资源《Laravel 9 中文文档》 看手册

这样：

return response()->json();

public function json($data = [], $status = 200, array $headers = [], $options = 0);

自己封装统一返回格式就好了。

我是封装个类似 BaseController，里面封装统一的接口返回相应

protected function apiResponse($responseData = null, $message = '', $code = 1, $statusCode = 200)
{
    return response()
       ->json(returnData($code, $message, $responseData, $statusCode))
        ->setStatusCode($statusCode);
}

returnData是helper封装的方法

if (! function_exists('returnData')) {
    function returnData($code = 0, $msg = '', $data = null, $statusCode = 200)
    {
       // ...
        return [
            'code' => $code,
            'msg' => $msg,
            'data' => $data
        ];
    }
}

最终控制器继承 BaseController就可以直接使用了

$list = [];
return $this->apiResponse($list, '请求列表成功');

public  function  toArray($request)  { 
    $data = parent::toArray($request);
    $data['image_url'] = optional($this->pre_home_doing_image)->url;
    $data['nickname'] = $this->yt_user->nickname;
    $data['headimgurl'] = $this->yt_user->headimgurl;
    return  ['data'=>$data];  
}

是这样吗？

这什么奇葩需求，搞得有点像 GraphQL

$list = $logs->orderBy('complete_time', 'desc')->paginate(20);
 $temp = $list->map(function ($v) {
            return new MaterialChangeLog($v);
   });
   $arr = $list->toArray();
   $arr['data'] = $temp;
$json=[
        'status'=>0,
        'msg' =>$msg,
        'data' =>$arr,
    ];
   return response()->json($json)->setEncodingOptions(JSON_UNESCAPED_UNICODE);

试试上面的代码。

BaseResourceCollection.php

<?php

namespace App\Ace\AdvanceSearch\Resource;

use App\Traits\Response\APIResponseCode;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Resources\Json\ResourceCollection;
use Illuminate\Pagination\AbstractPaginator;

class BaseResourceCollection extends ResourceCollection
{
    use CommonResourceTrait;

    /**
     * The additional data that should be added to the top-level resource array.
     *
     * @var array
     */
    public $with = [
        'code' => APIResponseCode::SUCCESS,
        'message' => 'success',
    ];

    /**
     * Create an HTTP response that represents the object.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\JsonResponse
     */
    public function toResponse($request): JsonResponse
    {
        $response = $this->resource instanceof AbstractPaginator
            ? (new CustomPaginatedResourceResponse($this))->toResponse($request)
            : parent::toResponse($request);

        return $response->setEncodingOptions(JSON_UNESCAPED_UNICODE + JSON_UNESCAPED_SLASHES);
    }
}

CustomPaginatedResourceResponse.php

<?php

namespace App\Ace\AdvanceSearch\Resource;

use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use Illuminate\Http\Resources\Json\PaginatedResourceResponse;
use JetBrains\PhpStorm\ArrayShape;

class CustomPaginatedResourceResponse extends PaginatedResourceResponse
{
    /**
     * Add the pagination information to the response.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    #[ArrayShape(['meta' => 'array'])]
    protected function paginationInformation($request): array
    {
        $paginator = $this->resource->resource;

        $currentPage = (int) $paginator->currentPage();

        $pageMeta = [
            'page' => $currentPage,
            'page_size' => (int) $paginator->perPage(),
            'has_more' => $paginator->hasMorePages(),
        ];

        if (is_a($paginator, LengthAwarePaginator::class)) {
            $pageMeta['total'] = (int) $paginator->total();
        }

        return [
            'meta' => $pageMeta,
        ];
    }
}

在资源那个文章内有提到data 包裹方式，我们这边的实现可参考

自定义一个 respondUtil 不就好了..

以下代码可以实现您的需求：

public function toArray($request)
{
    $data = parent::toArray($request);
    $data['image_url'] = optional($this->pre_home_doing_image)->url;
    $data['nickname'] = $this->yt_user->nickname;
    $data['headimgurl'] = $this->yt_user->headimgurl;
    $res['data'] = $data;
    return $res;
}

如果上面的代码不行，可以用下面的：

public function getBraceCaseCommentList($case_id)
{
    $brace_case_comments = BraceCaseComment::where('case_id', $case_id)->orderBy('id', 'desc')->paginate(10);
    $res['data'] = ResourcesBraceCaseComment::collection($brace_case_comments);
    return $res;
}

用这个方法解决了,感谢大家

public function usersInfo($id)
{
    $user = User::where('id', $id)->first();
    return $this->respondWithJsonData($user);
}


protected function respondWithJsonData($user)
{
    return response()->json([
        'data' => $user,
    ]);
}