php怎么返回成功_php接口返回成功状态的标准格式

{
    "code": 200,
    "message": "操作成功",
    "data": {
        // 实际的业务数据，可以是对象、数组、字符串或null
        "id": 1,
        "name": "用户A",
        "email": "userA@example.com"
    }
}

<?php

class ApiResponse
{
    /**
     * 返回成功的API响应
     *
     * @param mixed $data 实际返回的数据
     * @param string $message 提示信息
     * @param int $httpCode HTTP状态码，默认为200
     */
    public static function success($data = null, string $message = '操作成功', int $httpCode = 200)
    {
        // 设置Content-Type头，告知客户端返回的是JSON
        header('Content-Type: application/json; charset=utf-8');
        // 设置HTTP响应状态码
        http_response_code($httpCode);

        $response = [
            'code' => $httpCode, // 可以是HTTP状态码，也可以是自定义业务码
            'message' => $message,
            'data' => $data,
        ];

        // 输出JSON字符串，并确保中文不被转义
        echo json_encode($response, JSON_UNESCAPED_UNICODE);
        exit(); // 终止脚本执行，防止额外输出
    }

    /**
     * 返回失败的API响应 (作为对比，通常也需要)
     *
     * @param string $message 错误信息
     * @param int $httpCode HTTP状态码，默认为400
     * @param int $errorCode 业务错误码 (可选)
     */
    public static function error(string $message = '操作失败', int $httpCode = 400, int $errorCode = null)
    {
        header('Content-Type: application/json; charset=utf-8');
        http_response_code($httpCode);

        $response = [
            'code' => $errorCode ?? $httpCode, // 优先使用业务错误码
            'message' => $message,
            'data' => null, // 错误响应通常没有data字段，或者包含错误详情
        ];
        // 如果有更详细的错误信息，可以添加到这里
        // $response['errors'] = ['field' => 'value is required'];

        echo json_encode($response, JSON_UNESCAPED_UNICODE);
        exit();
    }
}

// 在控制器中的使用示例：
// 获取用户列表
// $users = ['user1', 'user2'];
// ApiResponse::success($users, '用户列表获取成功');

// 创建新用户成功
// ApiResponse::success(['id' => 123, 'name' => '新用户'], '用户创建成功', 201); // 201 Created

<?php

namespace App\Http\Responses;

use Illuminate\Http\JsonResponse;
use Symfony\Component\HttpFoundation\Response as HttpResponse; // 避免命名冲突

class ApiSuccessResponse extends JsonResponse
{
    public function __construct($data = null, string $message = '操作成功', int $status = HttpResponse::HTTP_OK, array $headers = [], int $options = 0)
    {
        // 构建统一的响应体结构
        $responseData = [
            'code' => $status, // 也可以是自定义业务成功码
            'message' => $message,
            'data' => $data,
        ];

        // 调用父类构造函数，完成JSON响应的构建
        parent::__construct($responseData, $status, $headers, $options);
    }

    /**
     * 添加额外的元数据到响应中，支持链式调用
     * 例如分页信息、统计数据等
     */
    public function withMeta(array $meta): self
    {
        // original属性存储了原始的响应数据数组
        $this->original['meta'] = $meta;
        // 重新设置JSON数据，确保meta字段被包含
        $this->setData($this->original);
        return $this;
    }

    /**
     * 允许设置自定义业务码，而不是直接使用HTTP状态码
     */
    public function withBusinessCode(int $businessCode): self
    {
        $this->original['code'] = $businessCode;
        $this->setData($this->original);
        return $this;
    }
}

// 在控制器中的使用示例：
// return new ApiSuccessResponse(['user_id' => 1, 'username' => 'testuser']);
// return (new ApiSuccessResponse(['items' => []], '列表为空'))->withMeta(['total' => 0, 'page' => 1]);
// return (new ApiSuccessResponse(['order_id' => 100], '订单创建成功', HttpResponse::HTTP_CREATED))->withBusinessCode(10001);