superwen/laravel-response

laravel-response

v1.0.0 2022-04-12 08:24 UTC

Requires

• php: ^7.2.5 || ^8.0
• illuminate/contracts: 5.5.*|5.6.*|5.7.*|5.8.*|^6.0|^7.0|^8.0|^9.0
• illuminate/support: 5.5.*|5.6.*|5.7.*|5.8.*|^6.0|^7.0|^8.0|^9.0

Requires (Dev)

• roave/security-advisories: dev-master

MIT

• superwen

README

基于sunnanbei/laravel-response更新的response类

这个包的目的是？

在项目开发时，由于获取数据方式不同(ORM、DB、自定义...)，会出现返回格式不统一的情况。
如果使用laravel自带的API资源(Resource)可以完美解决这个问题。
但，并不是每一个资源都需要去创建Resource的。
所以这个package的目的就是为了确保常见场景下，返回格式统一，保证唯一性。

如何使用

composer require superwen/laravel-response

//请求成功，输出数据，返回200
return Response::success($data);

{
    "error_code": 0,
    "message": "请求成功.",
    "data": {},
    "meta": {},
    "error": "",
    "debug": []
}

{
    "error_code": 0,
    "message": "请求成功.",
    "data": [],
    "meta": {},
    "error": "",
    "debug": []
}

{
    "error_code": 0,
    "message": "请求成功.",
    "data": {
        "id": 1,
        "name": "北京"
    },
    "meta": {},
    "error": "",
    "debug": []
}

{
    "error_code": 0,
    "message": "请求成功.",
    "data": [
        {
            "id": 1,
            "name": "北京"
        },
        {
            "id": 2,
            "name": "上海"
        }
    ],
    "meta": {
        "pagination": {
            "total": 100,
            "current_page": 1,
            "last_page": 50,
            "per_page": 2
        }
    },
    "error": "",
    "debug": []
}

//请求失败，系统异常，返回500
return Response::error();

//请求失败，返回200
return Response::fail();

//请求成功，返回201
return Response::created();

//请求成功，返回204
return Response::noContent();

//请求成功，返回403
return Response::forbidden();

//请求成功，返回404
return Response::notFound();

//接管异常
···
use Superwen\Response\Exceptions\JsonResponse;

class Handler extends ExceptionHandler
{
    use JsonResponse;
···