Início / Optitravel / Helpers / ApiHelper

success($data = null, string $message = '', int $code = 200)

• success($data = null, string $message = '', int $code = 200)
• Parameters
• Example

This method is used to send a standardized JSON response for successful API requests. It sets the appropriate HTTP status code, content type, and immediately ends the script after sending the response.

It is commonly used across controllers to provide consistent API output when an operation completes successfully.

Parameters

• $data – (array|null) Optional. The payload to include in the response.

• $message – (string) Optional. A human-readable success message.

• $code – (int) Optional. The HTTP status code (default is 200).

Example

use \App\Utils\ApiHelper;

$data = ['user_id' => 42, 'name' => 'Test Optigest'];
ApiHelper::success($data, 'User retrieved successfully', 200);

Output:

{
  "error": false,
  "code": 200,
  "message": "User retrieved successfully",
  "data": {
    "user_id": 42,
    "name": "Test Optigest"
  }
}

---

↑ (Última atualização: 06/05/2025)