ตัวอย่างการประยุกต์ใช้งาน RESTful API ใน CodeIgniter 4

CREATE TABLE `tbl_users` (
  `id` int(11) NOT NULL,
  `name` varchar(100) NOT NULL,
  `username` varchar(100) NOT NULL,
  `email` varchar(100) NOT NULL,
  `created_at` datetime NOT NULL DEFAULT current_timestamp(),
  `updated_at` datetime NOT NULL,
  `deleted_at` datetime NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

ALTER TABLE `tbl_users`
  ADD PRIMARY KEY (`id`);

ALTER TABLE `tbl_users`
  MODIFY `id` int(11) NOT NULL AUTO_INCREMENT;

$routes->resource('api/users', ['controller' =>'Api\Users']);

<?php namespace App\Models\Api; // กำหนด namespace
use CodeIgniter\Model; // เรียกใช้งาน Model class
class UsersModel extends Model 
{
    protected $table      = 'tbl_users';
    protected $primaryKey = 'id';
 
    protected $returnType     = 'array';
 
    protected $allowedFields = ['name', 'username', 'email'];
 
    protected $useSoftDeletes = true;
    protected $dateFormat = 'datetime'; // datetime, date, int
    protected $useTimestamps = true;
    protected $createdField  = 'created_at';
    protected $updatedField  = 'updated_at';
    protected $deletedField  = 'deleted_at';
 
    protected $validationRules    = [];
    protected $validationMessages = [];
    protected $skipValidation     = false;
}

<?php namespace App\Controllers\Api;
use CodeIgniter\RESTful\ResourceController;
class Users extends ResourceController
{
    protected $modelName = 'App\Models\Api\UsersModel';
    protected $format    = 'json';

    public function index(){

    }
	public function create(){

	}	
	public function show($id = null){

	}
	public function update($id = null){

	}
	public function delete($id = null){

	}
}

<?php namespace App\Controllers\Api;
use CodeIgniter\RESTful\ResourceController;
class Users extends ResourceController
{
    protected $modelName = 'App\Models\Api\UsersModel';
    protected $format    = 'json';

    public function index()
    {
		$response = $this->model->findAll();
        return $this->respond($response);
    }
	public function create(){
		if($this->model->save([
			'name' => 'new name test '.date("H:i:s"),
			'username' => 'new username test '.date("H:i:s"),
			'email' => 'new email test '.date("H:i:s"),
		])){
			$response = [
				'status' => 200,
				'message' => 'Data Created'
			];					
		} 
		return $this->respond($response);		
	}	
	public function show($id = null){
		if(!empty($id)){
			$response = $this->model->find($id);	
		}
		return $this->respond($response);
	}
	public function update($id = null){
		if($this->model->save([
			'id' => $id,
			'name' => 'edit name test '.date("H:i:s"),
			'username' => 'edit username test '.date("H:i:s"),
			'email' => 'edit email test '.date("H:i:s"),
		])){
			$response = [
				'status' => 200,
				'message' => 'Data Updated'
			];		
		} 
		return $this->respond($response);			
	}
	public function delete($id = null){
		if(!empty($id)){
			if($this->model->delete($id)){
				$response = [
					'status' => 200,
					'message' => 'Data Deleted'
				];							
			}		
		}
		return $this->respond($response);		
	}
}

get https://www.mysslweb.com/api/users  เรียก index()
get https://www.mysslweb.com/api/users/:segment เรียก show()
post https://www.mysslweb.com/api/users  เรียก create()
put https://www.mysslweb.com/api/users/:segment เรียก update() 
delete https://www.mysslweb.com/api/users/:segment เรียก delete()

// รองรับการกำหนด response method ทั่วไป
$this->respond($data, 200);
// รองรับการกำหนด failure response
$this->fail($errors, 400);
// รองรับการกำหนด created response
$this->respondCreated($data);
// รองรับการกำหนด  successfully deleted
$this->respondDeleted($data);
// Command executed by no response required
$this->respondNoContent();
// รองรับการกำหนด Client isn't authorized ไม่ได้รับสิทธิ์เข้าถึง API
$this->failUnauthorized();
// รองรับการกำหนด Forbidden action ไม่สามารถใช้งานส่วนที่กำหนดได้
$this->failForbidden();
// รองรับการกำหนด Resource Not Found ไม่พบข้อมูล
$this->failNotFound();
// รองรับการกำหนด Data did not validate ข้อมูลไม่ผ่านการตรวจสอบ
$this->failValidationError();
// รองรับการกำหนด Resource already exists มีข้อมูลแล้วในระบบ
$this->failResourceExists();
// รองรับการกำหนด Resource previously deleted ข้อมูลถูกลบไปก่อนหน้า
$this->failResourceGone();
// รองรับการกำหนด Client made too many requests การจำกัดจำนวนครั้งการเข้าถึง API
$this->failTooManyRequests();
// รองรับการกำหนด Internal Server Error เกิด error ฝั่ง server 
$this->failServerError();

<?php namespace App\Controllers\Api;
use CodeIgniter\RESTful\ResourceController;
use CodeIgniter\API\ResponseTrait; // เรียกใช้  ResponseTrait class
class Users extends ResourceController
{
	use ResponseTrait; // .ใช้  ResponseTrait 
	
    protected $modelName = 'App\Models\Api\UsersModel';
    protected $format    = 'json';

    public function index()
    {
		$response = $this->model->findAll();
        return $this->respond($response);
    }
	public function create(){
		$input = $this->request->getPost();
		$data = [
			'name' => $input['name'],
			'username' =>  $input['username'],
			'email' =>  $input['email'],	
		];
		$userID = $this->model->insert($data); // คืนค่า primary key
        return $this->respondCreated(['id' => $userID]);		
	}	
	public function show($id = null){
		$response = $this->model->find($id);	
		if($response){
			return $this->respond($response);
		}else{
			return $this->failNotFound('No Data Found with id '.$id);
		}
	}
	public function update($id = null){
		$input = $this->request->getRawInput();
		$data = [
			'name' => $input['name'],
			'username' =>  $input['username'],
			'email' =>  $input['email'],	
		];
		$user = $this->model->find($id);
		if($user){
			$this->model->update($id, $data);
			return $this->respond(['id' => $id]);		
		}else{
			return $this->failNotFound('No Data Found with id '.$id);
		}				
	}
	public function delete($id = null){
		if(!empty($id)){
			$user = $this->model->find($id);
			if($user){
				$this->model->delete($id);
				return $this->respondDeleted(['id' => $id]);			
			}else{
				return $this->failNotFound('No Data Found with id '.$id);
			}
		}
	}
}

protected $validationRules    = [
		'name'     => 'required',
		'username'     => 'required',
		'email'        => 'required|valid_email',
];

public function create(){
	$input = $this->request->getPost();
	$data = [
		'name' => $input['name'],
		'username' =>  $input['username'],
		'email' =>  $input['email'],	
	];
	if($userID = $this->model->insert($data)){ // ตรวจสอบการ validated ไปด้วย
		return $this->respondCreated(['id' => $userID]);	
	}else{
		return $this->failValidationError(implode("",$this->model->errors()));
	}        	
}	
public function update($id = null){
	$input = $this->request->getRawInput();
	$data = [
		'name' => $input['name'],
		'username' =>  $input['username'],
		'email' =>  $input['email'],	
	];
	$user = $this->model->find($id);
	if($user){
		if($this->model->update($id, $data)){  // ตรวจสอบการ validated ไปด้วย
			return $this->respond(['id' => $id]);		
		}else{
			return $this->failValidationError(implode("",$this->model->errors()));
		}	
	}else{
		return $this->failNotFound('No Data Found with id '.$id);
	}				
}