Tích hợp API REST trong CakePHP

API REST (Representational State Transfer) cho phép các ứng dụng trao đổi dữ liệu qua giao thức HTTP theo định dạng như JSON hoặc XML. Trong bài viết này, chúng ta sẽ tìm hiểu cách tích hợp API REST, tạo API trong CakePHP và xử lý dữ liệu JSON.

1. Tạo API trong CakePHP

a. Cấu hình Routing

Trong CakePHP, bạn cần cấu hình các route cho API trong file config/routes.php. Ví dụ, chúng ta tạo API để quản lý các bài viết:

use Cake\Routing\Route\DashedRoute;
use Cake\Routing\Router;

Router::plugin('Api', function ($routes) {
    $routes->setExtensions(['json']);
    $routes->resources('Posts');
    $routes->fallbacks(DashedRoute::class);
});

b. Tạo Controller cho API

Tạo một controller trong namespace Api. Ví dụ: src/Controller/Api/PostsController.php:

namespace App\Controller\Api;

use App\Controller\AppController;
use Cake\Http\Exception\NotFoundException;

class PostsController extends AppController
{
    public function initialize(): void
    {
        parent::initialize();
        $this->loadModel('Posts');
        $this->RequestHandler->renderAs($this, 'json');
    }

    // API lấy danh sách bài viết
    public function index()
    {
        $posts = $this->Posts->find()->all();
        $this->set([
            'data' => $posts,
            '_serialize' => ['data']
        ]);
    }

    // API xem chi tiết bài viết
    public function view($id = null)
    {
        $post = $this->Posts->get($id);
        $this->set([
            'data' => $post,
            '_serialize' => ['data']
        ]);
    }

    // API thêm bài viết
    public function add()
    {
        $post = $this->Posts->newEmptyEntity();
        $post = $this->Posts->patchEntity($post, $this->request->getData());

        if ($this->Posts->save($post)) {
            $message = 'Bài viết đã được thêm thành công!';
        } else {
            $message = 'Thêm bài viết thất bại!';
        }

        $this->set([
            'message' => $message,
            'data' => $post,
            '_serialize' => ['message', 'data']
        ]);
    }
}

2. Xử lý Dữ Liệu JSON

a. Gửi Dữ Liệu JSON Từ Client

Đảm bảo client gửi dữ liệu JSON với Content-Type: application/json. Ví dụ sử dụng cURL:

curl -X POST http://localhost/api/posts.json \
-H "Content-Type: application/json" \
-d '{"title": "Bài viết mới", "content": "Nội dung bài viết"}'

b. Nhận và Xử Lý JSON trong CakePHP

Trong CakePHP, bạn có thể lấy dữ liệu JSON từ request như sau:

$data = $this->request->getData();

Khi dữ liệu được gửi đến server, CakePHP tự động chuyển đổi JSON thành array PHP.

c. Trả Về Dữ Liệu JSON

CakePHP hỗ trợ trả dữ liệu JSON dễ dàng bằng cách sử dụng _serialize:

$this->set([
    'data' => $responseData,
    '_serialize' => ['data']
]);

3. Một Số Lưu Ý

• Authentication: Bảo vệ API bằng cách tích hợp Auth Middleware hoặc JWT.
• Validation: Sử dụng các rule trong model để xác minh dữ liệu trước khi lưu.
• Error Handling: Xử lý lỗi bằng cách ném các ngoại lệ (exception) như NotFoundException hoặc BadRequestException.