cerenimo/response-messages

dev-main 2023-07-31 08:18 UTC

This package is auto-updated.

Last update: 2024-09-30 02:10:49 UTC


README

composer require cerenimo/response-messages "dev-main" 

ResponseTrait 是一个用于在 Laravel 和 Lumen 中标准化 HTTP 响应消息的特质。您可以使用上述 composer 命令安装它。要在您的类中使用它,请使用 "use" 关键字添加以下行

use CerenOzkurt\ResponseMessages\ResponseTrait;

class YourClass {

use ResponseTrait;
// ...
}

在您的函数内部,您可以使用它如下

return $this->responseData(['message' => $message]);

响应 / 200 OK

{
    "result": true,
    "data": {
        "message": {
            "id": 372,
            "role": "user",
            "message": "Hi",
            "end_conversation": 0,
            "created_time": "2023-05-30T09:28:01.000000Z",
            "conversation_completion_count": "0.60",
            "word_count": 1
        }
    }
}


该包提供以下功能
  • responseData($data, $message = null) : 如果请求成功且需要返回数据,请使用。

  • responseSuccess($message = null) : 如果请求成功,请使用。

  • responseError($message = null, $status = 500) : 如果请求出错,请使用。

  • responseValidation($validation) : 如果有验证错误,请使用。

  • responseDataNotFound($data_name = null) : 如果发生未找到错误,请使用。

  • responseForbidden($message = null) : 在禁止错误中使用。

  • responseUnauthorized($message = null) : 在未经授权错误中使用。

  • responseTryCatch($message = null, $status = 500) : 在 try-catch 错误中使用。

  • responseDataCount($data) : 如果数据需要计数信息,请使用。

  • responseBadRequest($message = null) : 如果发送的请求不正确,请使用。

  • responseConflict($message = null) : 如果由于预定的规则或版本差异导致不匹配,请使用。

  • responsePayloadTooLarge($message = null) : 如果请求实体远大于服务器定义的限制,请使用。

  • responseTooManyRequests($message = null) : 如果网站超过了指定的请求限制,请使用。

  • responseInternalServer($message = null) : 如果发生服务器端错误,请使用。

  • responseNotImplemented($message = null) : 如果服务器不支持满足请求所需的功能,请使用。