如何在 Laravel 中返回 JSON 数据的同时设置 HTTP 状态码？

php

2024-03-22 06:59:44

在 Laravel 中返回 JSON 数据的同时设置 HTTP 状态码

问题

在 Laravel 中，有时需要返回 JSON 数据的同时设置特定的 HTTP 状态码。例如，当成功创建或更新资源时，可能需要返回 201 Created 状态码，或在出现验证错误时返回 400 Bad Request 状态码。

解决方案

Laravel 提供了多种方法来轻松实现此目的：

1. 使用 `response` 函数

response 函数允许你创建自定义的 HTTP 响应。你可以使用它来同时设置状态码和 JSON 数据：

return response()->json([
    'hello' => $value
], 201);

2. 使用 `withStatusCode` 方法

withStatusCode 方法允许你将状态码添加到现有的 JSON 响应中：

return Response::json([
    'hello' => $value
])->withStatusCode(201);

3. 使用 `json` 辅助函数

json 辅助函数可以用于创建 JSON 响应。它允许你同时设置状态码和 JSON 数据：

return json([
    'hello' => $value
], 201);

设置消息

如果你想在 JSON 对象中包含一条消息，可以使用 message 键：

return response()->json([
    'message' => '成功创建！',
    'data' => $value
], 201);

示例

以下是一个完整的示例，说明如何在 Laravel 中返回带有状态码 201 和消息的 JSON 数据：

return response()->json([
    'message' => '数据创建成功！',
    'data' => $value
], 201);

总结

使用这些方法，你可以轻松地在 Laravel 中返回 JSON 数据的同时设置 HTTP 状态码和消息。这使你能够为不同的响应情况提供适当的 HTTP 状态，并通过提供有用的消息来增强用户体验。

常见问题解答

如何设置 HTTP 状态码 400？

return response()->json([
    'message' => '验证失败！'
], 400);

如何返回带有数组数据的 JSON？

return response()->json([
    'data' => [
        'name' => 'John',
        'age' => 30
    ]
], 200);

如何在 JSON 数据中包含错误消息？

return response()->json([
    'errors' => [
        'name' => ['The name field is required.'],
        'age' => ['The age field must be a number.']
    ]
], 422);

我可以在 JSON 数据中包含分页信息吗？

return response()->json([
    'data' => $users->items(),
    'pagination' => [
        'total' => $users->total(),
        'current_page' => $users->currentPage(),
        'per_page' => $users->perPage()
    ]
], 200);