laravel ApiResponse接口统一响应封装

一,新增接口返回码配置文件

在config中新增配置文件apicode.php

<?phpreturn [
'apicodes'=>[/*** @Message("OK")* 对成功的 GET、PUT、PATCH 或 DELETE 操作进行响应。也可以被用在不创建新资源的 POST 操作上*/'HTTP_OK' => 200,/*** @Message("Created")* 对创建新资源的 POST 操作进行响应。应该带着指向新资源地址的 Location 头*/'CREATED' => 201,/*** @Message("Accepted")* 服务器接受了请求,但是还未处理,响应中应该包含相应的指示信息,告诉客户端该去哪里查询关于本次请求的信息*/'ACCEPTED' => 202,/*** @Message("No Content")* 对不会返回响应体的成功请求进行响应(比如 DELETE 请求)*/'NO_CONTENT' => 203,/*** @Message("Not Modified")* HTTP缓存header生效的时候用*/'NOT_MODIFIED' => 304,/*** @Message("Temporary Redirect")* 对应当前请求的响应可以在另一个 URI 上被找到,客户端应该保持原有的请求方法进行请求*/'TEMPORARY_REDIRECT' => 307,/*** @Message("Bad Request")* 请求异常,比如请求中的body无法解析*/'BAD_REQUEST' => 400,/*** @Message("Unauthorized")* 没有进行认证或者认证非法*/'UNAUTHORIZED' => 401,/*** @Message("Forbidden")* 服务器已经理解请求,但是拒绝执行它*/'FORBIDDEN' => 403,/*** @Message("Not Found")* 请求一个不存在的资源*/'NOT_FOUND' => 404,/*** @Message("Method Not Allowed")* 所请求的 HTTP 方法不允许当前认证用户访问*/'METHOD_NOT_ALLOWED' => 405,/*** @Message("Gone")* 表示当前请求的资源不再可用。当调用老版本 API 的时候很有用*/'GONE' => 410,/*** @Message("Unsupported Media Type")* 如果请求中的内容类型是错误的*/'UNSUPPORTED_MEDIA_TYPE' => 415,/*** @Message("Unprocessable Entity")* 用来表示校验错误*/'UNPROCESSABLE_ENTITY' => 422,/*** @Message("Too Many Requests")* 由于请求频次达到上限而被拒绝访问*/'TOO_MANY_REQUESTS' => 429,/*** @Message("Internal Server Error")* 服务器遇到了一个未曾预料的状况,导致了它无法完成对请求的处理*/'SERVER_ERROR' => 500,/*** @Message("Bad Gateway")* 作为网关或者代理工作的服务器尝试执行请求时,从上游服务器接收到无效的响应*/'BAD_GATEWAY' => 502,/*** @Message("Service Unavailable")* 由于临时的服务器维护或者过载,服务器当前无法处理请求。这个状况是临时的,并且将在一段时间以后恢复。如果能够预计延迟时间,那么响应中可以包含一个 Retry-After* 头用以标明这个延迟时间(内容可以为数字,单位为秒;或者是一个 HTTP 协议指定的时间格式)。如果没有给出这个 Retry-After 信息,那么客户端应当以处理 500 响应的方式处理它*/'SERVICE_UNAVAILABLE' => 50,/*** @Message("Gateway Timeout")*/'GATEWAY_TIMEOUT' => 504,/*** @Message("HTTP Version Not Supported")*/'HTTP_VERSION_NOT_SUPPORTED' => 505]
];

二,新增接口统一响应封装trait

<?phpnamespace App\traits;use Illuminate\Support\Facades\Response;trait ApiResponse
{/*** @var int*/protected $statusCode =  200;/*** @return mixed*/public function getStatusCode(){return $this->statusCode;}/*** @param $statusCode* @return $this*/public function setStatusCode($statusCode){$this->statusCode = $statusCode;return $this;}/*** @param $data* @param array $header* @return mixed*/public function respond($data, $header = []){return Response::json($data, $this->getStatusCode(), $header);}/*** @param $status* @param array $data* @param null $code* @return mixed*/public function status($status, array $data, $code = null){if ($code) {$this->setStatusCode($code);}$status = ['status' => $status,'code' => $this->statusCode];$data = array_merge($status, $data);return $this->respond($data);}/*** @param $message* @param int $code* @param string $status* @return mixed*/public function error($message, $code = 'BAD_REQUEST'){return $this->status('error', ['message' => $message,'code' => config('apicode.apicodes.'.$code)],config('apicode.apicodes.'.$code));}/*** @param $message* @param string $status* @return mixed*/public function message($message, $status = "success"){return $this->status($status, ['message' => $message]);}/*** @param $data* @param string $status* @return mixed*/public function success($data, $status = "success"){return $this->status($status, compact('data'));}
}

三,使用

先 use ApiResponse;

use ApiResponse;
public function login(Request $request){$input = $request->only('account', 'password');//此处可以自己查数据库,判断是否用户名和密码正确$user = User::query()->where(['account' => $input['account']])->firstOrFail();//生成token两种方式//$token = Auth::guard('api')->fromUser($user);$token = JWTAuth::fromUser($user);//dd($token);die;$data['token']="bearer ".$token;$data['user']=$user;return $this->success($data);}

四,接管系统异常返回

首先我们在app/Exceptions目录新建一个ExceptionHandler.php继承自同目录下的Handler.php代码如下
在render方法里,我们根据.env文件中的APP_DEBUG来判断,如果是调试模式,我们还是按照默认方式来渲染错误,如果是非调试模式,我们就返回JSON格式的信息

<?phpnamespace App\Exceptions;
use App\traits\ApiResponse;
class ExceptionHandler extends Handler
{use ApiResponse;public function render($request, \Throwable $exception){if (env('APP_DEBUG')) {return parent::render($request, $exception);}return $this->error($exception->getMessage(),'UNAUTHORIZED');}
}

然后我们在bootstrap/app.php中,使用我们自定义的异常处理类ExceptionHandler替换掉默认的Handler类

$app->singleton(Illuminate\Contracts\Debug\ExceptionHandler::class,//App\Exceptions\Handler::classApp\Exceptions\ExceptionHandler::class
);

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/503509.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

优化云的 10 种方法...

云优化是正确选择正确的资源并将其分配给工作负载或应用程序的过程&#xff0c;确保资源得到有效利用并优化性能。这是为了确保您充分利用云基础设施。这包括确保您没有过度配置&#xff08;或者实际上配置不足&#xff09;资源&#xff0c;并确保您为正确的任务使用正确的服务…

职场的过早优化

过早优化&#xff0c;指的是还没弄清楚需求未来的变化的走向的时候&#xff0c;忽略了更重要的问题。 放在职业发展上&#xff1a;你在没有积累足够职场资源&#xff08;眼界、能力、人脉等等&#xff09;&#xff0c;也没有对职业发展形成清晰认知的时候&#xff0c;就过早地进…

UE学习笔记--解决滚轮无法放大蓝图、Panel等

我们发现有时候创建蓝图之后&#xff0c;右上角的缩放是1&#xff1a;1 但是有时候我们可能需要放的更大一点。 发现一直用鼠标滚轮像上滚动&#xff0c;都没有效果。 好像最大只能 1&#xff1a;1. 那是因为 UE 做了限制。如果希望继续放大&#xff0c;我们可以按住 Ctrl 再去…

Python读取hbase数据库

1. hbase连接 首先用hbase shell 命令来进入到hbase数据库&#xff0c;然后用list命令来查看hbase下所有表&#xff0c;以其中表“DB_level0”为例&#xff0c;可以看到库名“baotouyiqi”是拼接的&#xff0c;python代码访问时先连接&#xff1a; def hbase_connection(hbase…

精品SSM的选修课管理系统选课签到打卡

《[含文档PPT源码等]精品基于SSM的选修课管理系统设计与实现[包运行成功]》该项目含有源码、文档、PPT、配套开发软件、软件安装教程、项目发布教程、包运行成功&#xff01; 软件开发环境及开发工具&#xff1a; Java——涉及技术&#xff1a; 前端使用技术&#xff1a;HTM…

软考中级 软件设计师备考经验

考试介绍 软考中级的软件设计师需要考两个部分&#xff0c;选择题和大题&#xff0c;每科满分75&#xff0c;需要在同一次考试中两科同时大于等于45分才算通过。考试的内容包括计算机组成原理、数据结构、数据库、专业英语、信息安全、计算机网络等&#xff0c;范围比较广但考…

Linux技巧|centos7|重新认识和学习egrep和grep命令

前言&#xff1a; 相信提高文本检索工具&#xff0c;大家脑海里肯定有很多工具会自动跳出来&#xff0c;比如&#xff0c;grep&#xff0c;egrep&#xff0c;sed&#xff0c;cat&#xff0c;more&#xff0c;less&#xff0c;cut&#xff0c;awk&#xff0c;vim&#xff0c;vi…

【airtest】自动化入门教程(二)airtest操作

目录 一、touch 二、wait 三、swipe 四、exists 五、text 六、keyevent 七、snapshot 八、sleep 九、断言 9.1 assert_exists 9.2 assert_not_exists 9.3 assert_equal 9.4 assert_not_equal 前言&#xff1a;本文主要针对aritest部分的基础操作,aritest是一个跨平…

今日早报 每日精选15条新闻简报 每天一分钟 知晓天下事 3月2日,星期六

每天一分钟&#xff0c;知晓天下事&#xff01; 2024年3月2日 星期六 农历正月廿二 1、 气象局&#xff1a;3月份仍有5次冷空气影响我国&#xff1b;全国多地或提前入春。 2、 央行&#xff1a;将外籍来华人员移动支付单笔交易限额由1000美元提高到5000美元。 3、 神舟十七号航…

ABAP - OOALV 单元格 F4实现

方式一:使用标准数据表&#xff0c;FIELDCAT字段设置值 gs_fieldcat-ref_table X. "列可编辑gs_fieldcat-ref_table MARA. "F4 参考表gs_fieldcat-ref_field MATNR. "F4 参考字段 方式二.使用自定义数据 &#xff0c;实现效果如下图…

达梦数据库基础操作(四):数据表 CRUD 功能

达梦数据库基础操作(四)&#xff1a;数据表 CRUD 功能 1. 数据表 CRUD 功能 1.1 插入数据 # 使用 INSERT INTO 语句向 department 表插入数据记录。 INSERT INTO department VALUES(666, 数据库产品中心); # 使用 INSERT INTO 语句向 employee 表插入数据记录。 INSERT INTO …

基于图数据库构建知识图谱平台应用实践

▏摘要 中信证券基于分布式图数据库StellarDB&#xff0c;替代国外开源图数据库产品&#xff0c;打造全新的企业级知识图谱平台&#xff0c;应用于同一客户集团画像、科创板关联发现、风险事件报告、全球企业关联图谱、产业链图谱、投研图谱、反洗钱与稽核图谱、元数据图谱等应…