Hướng dẫn tùy chỉnh API

1) Tùy chỉnh controller

  • Tất cả API mặc định của GP247 cho phép tùy chỉnh controller mà không cần sửa mã nguồn core.

Các bước thực hiện

  • Bước 1: Tạo controller có namespace bắt đầu bằng App\ tương ứng trong thư mục app, và extend lại controller gốc.
  • Bước 2: Tạo các function ghi đè (override) function gốc nếu bạn muốn chỉnh sửa hành vi.

Ví dụ

  • Mục tiêu: Tùy chỉnh controller gốc GP247\Core\Api\Controllers\AdminController.php.
  • Thực hiện: Tạo file app/GP247/Core/Api/Controllers/AdminController.php với namespace App\GP247\Core\Api\Controllers và kế thừa từ controller gốc.
namespace App\GP247\Core\Api\Controllers;

use GP247\Core\Api\Controllers\AdminController as VendorAdminController;

class AdminController extends VendorAdminController
{
    public function __construct()
    {
        parent::__construct();
    }

    // Override original methods here to customize behavior
    // public function yourMethodName(Request $request)
    // {
    //     // Implement your custom logic
    // }
}

Ghi chú:

  • Không chỉnh sửa mã trong thư mục vendor/ để đảm bảo an toàn khi cập nhật.
  • Đảm bảo namespace chính xác App\... trùng với cấu trúc thư mục trong app/.

2) Tùy chỉnh các thông số mặc định của API

  • Hầu hết các cấu hình API trong GP247 có thể chỉnh sửa thông qua biến môi trường trong tệp .env (không cần sửa core).
  • Tham khảo đầy đủ các khóa cấu hình và giá trị mặc định tại gp247-config.php.

Quy trình khuyến nghị:

  • Bước 1: Mở .env và thêm/chỉnh sửa các biến cấu hình liên quan (ví dụ: GP247_API_MODE=0 để vô hiệu hóa API).
  • Bước 2: Làm mới cấu hình ứng dụng:
php artisan config:clear
php artisan cache:clear
  • Bước 3: Khởi động lại các tiến trình nền (nếu có) như queue/schedule để áp dụng cấu hình mới.