RESTful API 的最佳返回方式应该是怎样的?

jsonapi.org 可以参考下这个（小心前端抱怨，解析不好骂后端）

（建议科上学网，没找到较新较全面的中文站）

通过 include 加载关联，在 relationships 中返回

通过 fields 限制仅返回需要的字段

通过 filter 传递筛选条件

通过 page 获取指定范围数据

ResponseFactory::macro('succJson', function ($data, $status=200) {
            return Response::json([
                'code' => $status,
                'message' => 'success',
                'data' =>  $data,
            ], $status);
        });
// use
return response()->succJson(...);

{
    "code": 200,
    "message": "success",
    "data":[]
}

只要大致的方向是对的，我觉得没有必要纠结这个吧。不同公司接口返回都大同小异，满足业务即可。

GraphQL :relaxed:

有关结构：链接

{
   "data": [{ ... }, { ... }],
   "message": "You have a lot todo!",
   "errors": [],
   "status": 1,
}

我们是在BaseController写了方法sendSuccess, sendError, sendResponse。

关于内容，由于我司没有采用前后端分离开发，故Resource只用于API接口，也并不是所有API接口都用到Resource。对后台管理系统，是直接传整个变量过去。

关联的数据可以在各自的Controller方法里去load或用with获取即可。

有些公司的做法是多加一层Representer层专门处理如何展示数据。

我们是Controller -> Result -> Service -> Model 结构去写了应用
Controller ： 只有注入相应Request和Return语句
Result ： 处理了返回数据结构，楼主说的返回Resource或者return view()或者 return response()->json()都写在了这里
Service ：基本上所有的非数据库逻辑写在了这里
Model : 数据库逻辑(ORM, Query Builder) 写在了这里

返回的数据是
{
“code”: “0000”,
“message”: “Success”,
“description”: “return XXX”,
“data”: {}
}

公司内部也有人提出分层太多，但还在继续磨合当中，参考参考就行了

我个人的话，用 resource 来返回

这种东西公司统一了就行

github.com/weiwenhao/tree-ql 这是当时我的想法，无非就是类似 graphql 一样， 客户端带参数微调就行了。

@gema 是的。但是可以复用，就不用可以复用的数据结构每次都再写一遍。如果配合 swagge。就很方便

每一个 resource 对应 swagge 的 model

if (!function_exists('apiSuccess')) {
    function apiSuccess($data = [], $msg = '成功', $headers = []): \Illuminate\Http\JsonResponse
    {
        return apiResponse($msg, 0, $data, $headers);
    }
}

if (!function_exists('apiError')) {
    function apiError($msg = '失败', $code = -1, $data = [], $headers = []): \Illuminate\Http\JsonResponse
    {
        return apiResponse($msg, $code, $data, $headers);
    }
}

if (!function_exists('apiResponse')) {
    function apiResponse($msg, $code, $data, $headers): \Illuminate\Http\JsonResponse
    {
        $response = [
            'code' => $code,
            'msg'  => $msg,
            'data' => $data,
        ];

        return response()
            ->json($response)
            ->withHeaders($headers)
            ->withCallback(request('callback'));
    }
}

result

{
    "code": 0,
    "msg": "success",
    "data": []
}

{
    "code": -1,
    "msg": "testtst",
    "data": []
}