调用REST API时如何添加status code响应?附现有代码参考
REST API请求状态码捕获与传参校验落地实现
控制器层前置参数校验,减少非法传参
目前控制器直接读取请求参数组包,没有做合法性校验,很容易出现空值、格式错误导致的传参失败。直接在控制器方法开头补校验逻辑:
public function user(Request $request) { // 校验请求参数,不合法自动返回422状态码 $validated = $request->validate([ 'firstname' => 'required|string|max:50', 'lastname' => 'required|string|max:50', ]); // 校验通过后按下游接口要求组参数 $params = [ "firstName" => $validated['firstname'], "lastName" => $validated['lastname'], ]; return $this->VoucherFactory->saveUser($params); }
校验逻辑生效后,凡是必填字段缺失、格式不符合要求的请求,会直接返回422状态码,不会把非法参数传到下游接口。
saveUser方法中补全状态码捕获逻辑
现在代码的核心问题是直接返回HTTP请求结果,没有接住完整的响应对象,根本无法提取状态码。在预留的逻辑位置补全如下代码:
public function saveUser($params) { try { // 接住HTTP客户端返回的完整响应对象,不直接return $response = $this->HttpClient->makeRequestPost($params, 'api/users', true); // 从响应对象提取状态码,根据你封装的HTTP客户端实际方法调整取值方式 // 常见的取值方法有getStatusCode()、status(),不要写死方法名 $statusCode = $response->getStatusCode(); // 按状态码分支返回统一结构的响应 if ($statusCode >= 200 && $statusCode < 300) { // 2xx成功状态:返回解析后的业务数据 return response()->json([ 'code' => $statusCode, 'data' => $response->getBody()->getContents(), 'message' => '用户信息保存成功' ], $statusCode); } elseif ($statusCode === 400) { // 400错误:多为参数格式、字段名不匹配导致 return response()->json([ 'code' => $statusCode, 'message' => '请求参数不符合接口要求,请核对字段名、格式是否与文档一致' ], $statusCode); } elseif (in_array($statusCode, [401, 403])) { // 权限类错误 return response()->json([ 'code' => $statusCode, 'message' => '接口调用权限校验失败' ], $statusCode); } elseif ($statusCode >= 500) { // 下游服务端错误 return response()->json([ 'code' => $statusCode, 'message' => '下游服务暂时异常,请稍后重试' ], $statusCode); } } catch (\Exception $e) { // 捕获网络超时、连接失败、非2xx状态直接抛异常等场景 // 若异常对象自带下游返回的状态码,可从异常实例中提取替换这里的503 return response()->json([ 'code' => 503, 'message' => '请求发送失败:' . $e->getMessage() ], 503); } }
传参问题排查要点
出现接口无法正确接收参数时,优先核对以下高频问题点:
- 字段大小写匹配:下游接口要求的字段名是
firstName,不要在组参数时写成全小写或全大写 - 请求头匹配:JSON格式的POST请求,需要设置
Content-Type: application/json头,否则参数会被按表单格式传递,下游解析不到 - 参数位置匹配:接口要求参数放在请求体里,不要错误放到URL查询参数上
- 临时日志记录:发请求前把最终组装的
$params、请求头信息打到日志里,对照接口文档逐字段核对
内容的提问来源于stack exchange,提问作者frustrated-dev
相关产品推荐
相关产品推荐

