CodeIgniter 4 Restfull API Application Starter
Codeigniter 4 Restfull is the creation of Restfull API with the codeigniter 4 framework. Use is very simple and easy to use. And support with 4 types of security authentication ex. JWT, Basic, Key, Token
You can manage api using database or File configuration
follow Setup Configuration!
Installation & updates
- composer
composer create-project appkita/ci4restfull-starter
cd ci4restfull-starter
composer update
-manual
- Download latest release from
https://github.com/gunantos/ci4restfull-starter/releases
- extract to public_html
composer install
Setup
- Copy
env
to.env
and tailor for your app, specifically the baseURL, any database settings and Restfull setting.
or
- Open Folder
App/Config/Restfull
and edit
//you can set database of file
public $cekfrom = 'file'
//configuration user cek
public $user_config = [
'model' => 'UserModel', //model name or parameter if you using file
'username_coloumn'=>'email',
'password_coloumn'=>'password',
'key_coloumn' => 'apikey',
'path_coloumn'=>'path',
'block_coloumn'=>'isblock',
'whitelist_coloumn'=>'whitelist',
'blacklist_coloumn'=>'blacklist'
];
//if you using file $cekfrom
$UserModel = [
[
'email'=>'[email protected]',
'password'=>'password',
'apikey'=>'123123',
'isblock'=>false, //if you block return true
'whitelist'=>[], //add whitelist ip address
'blacklist'=>[], //add blacklist ip address
'path'=>'*' //use * for allow all access or array controllername_methodname
]
]
//Configuration your Header API KEY
public $haderKey = 'X-API-KEY';
/**
* @var array $allowed_key_parameter
* if you API KEY allowed get from parameter GET, POST, or JSON
*/
public $allowed_key_parameter = ['get', 'post', 'json'];
//configuration data include on json token
$token_data = 'username';
public $allowed_format = ['json', 'xml', 'csv'];
/**
* @var string $default_format
*/
public $default_format = 'json';
- Create new Controller extends
RestfullApi
<?php
namespace App\Controllers;
use \Appkita\CI4Restfull\RestfullApi;
use \App\Models\UserModel;
class Home extends RestfullApi
{
#protected $modelName = 'UserModel';
protected $model;
protected $allowed_format = ['json'];
protected $auth = ['key'];
function __construct() {
$this->model = new UserModel();
}
public function index()
{
return $this->respond(['status'=>true, 'data'=>$this->model->findAll()]);
}
public function show($id = null)
{
return $this->respond(['status'=>true, 'data'=>$this->model->find($id)]);
}
public function create() {
die('create ');
}
public function update($id = null) {
die('update '. $id);
}
public function deleted($id = null) {
die('deleted '. $id);
}
}
- Run application with
spark
orhost
//spark
php spark serve
- acess api
http://localhost:8080
spark runhttp://localhost/yourapi/public
xamp or wamp
Important
Please read the user guide of Codeigniter 4
Server Requirements
PHP version 7.3 or higher is required, with the following extensions installed:
Additionally, make sure that the following extensions are enabled in your PHP: