Xây dựng API REST đơn giản trong PHP

Tram Ho

RESTful API

RESTful API là một tiêu chuẩn dùng trong việc thiết kế API cho các ứng dụng web (thiết kế Web services) để tiện cho việc quản lý các resource. Nó chú trọng vào tài nguyên hệ thống (tệp văn bản, ảnh, âm thanh, video … ), bao gồm các trạng thái tài nguyên được định dạng và được truyền tải qua HTTP.

Xây dựng một project REST API

ban đầu ta tạo một project với cấu trúc thư mục như sau:

thêm đoạn mã sau vào file composer.json, rồi run : composer install

sau khi ta chạy lệnh composer install trong thư mục project sẽ tạo ra một thư mục có tên /vendor

khi này thư viện DotEnv đã được cài đặt thành công

tiếp theo nếu chúng ta muốn cài đặt git cho project thì trong .gitignore thêm tên file .env và thư mục vendor để không đẩy các file .env và vendor lên git tránh mất thông tin và thuận tiện cho làm việc theo nhóm.

Tạo thêm file .env.example chứa nội dung như sau:

Tạo thêm file bootstrap.php để tả các biến môi trường touch bootstrap.php có nội dung như sau:

Tiếp theo chúng ta tạo database để lưu và thao tác với dữ liệu, trong bài viết này sẽ dùng MySql.

  • tạo database có tên là api_example

  • tạo table có tên person

khi này đã có database việc tiếp theo là config trong file .env và .env.example

Bước tiếp theo chúng ta sẽ tạo 1 class để thực hiện kết nối đến cơ sở dữ liệu và khỏi tạo kết nối trong file bootstrap.php

update file

khi này việc kết nối database đã xong, chúng ta sẽ tạo một số bản ghi trong bảng person vừa tạo ở trên bằng việc tạo một file dbseed.php có nội dung như sau

Ở phạm vi bài viết này để thao tác với cơ sở dữ liệu thì chúng ta sẽ ko thông qua hệ thống ORM như Eloquent hay Doctrine mà ở sẽ viết câu lệnh truy vấn trực tiếp trong class PersonGateway

để thao tác với dữ liệu thì chúng ta chỉ cần khai báo và gọi đến các hàm

Implement the PHP REST API

Để tiếp nhận những yêu cầu và xử lý thì chúng ta sẽ tạo file /public/index.phpsrc/Controller/PersonController.php

Để test các api mà chúng ta vừa xây dựng ở trên thì cần đến một công cụ như Postman nhưng trước tiên phải khỏi động bằng câu lệnh

php -S 127.0.0.1:8000 -t public

sau đó connect đến 127.0.0.1:8000 và thực hiện test 5 API sau

Qua bài viết này chúng ta đã phần nào hiểu rõ hơn các bước xây dựng một API REST với ngôn ngữ PHP.

Tài liệu tham khảo

developer.okta.com

Chia sẻ bài viết ngay

Nguồn bài viết : Viblo