coreuxio/lib

一组用于加速Laravel API开发的工具

维护者

详细信息

github.com/coreuxio/lib

主页

源代码

问题

安装次数: 3

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

公开问题: 0

v1.0.8 2023-04-23 14:18 UTC

Requires

proprietary 8db665641ef68bb562c51e543a112c141c6e9455

toolscommonservices

This package is auto-updated.

Last update: 2024-09-23 17:33:45 UTC

README

一组个人工具，用于开始构建API或Laravel应用

功能

  • 标准API响应
  • 请求时间

标准API响应

添加元数据有助于从Webhook日志中进行调试

{
    "status": "success",
    "data": "This could be anything including arrays and object",
    "errors": [],
    "meta": {
        "httpCode": 200,
        "milliseconds": 120,
        "timestamp": "2023-04-07 17:19:05"
    },
    "pagination": null
}

用法

在您的App/Http/Controller中添加ApiResponse作为trait

use \Coreux\Lib\API\Traits\ApiResponse;
class Controller extends BaseController
{
    use AuthorizesRequests, ValidatesRequests, ApiResponse;
}

现在您可以返回这个作为成功的返回

return $this->apiReturn($users);

您还可以使用Eloquent的分页

return $this->apiReturnPaginated($usersPaginated,$transformer=null);

或者您也可以返回一个错误并指定代码

return $this->apiError($errors,$code=400);

请求时间

在您的index.php（App入口）的以下行定义，API响应将能够返回代码运行的时间（毫秒）

define('APP_START', microtime(true));