meksiabdou/ci4-restful

1.0.0 2022-07-03 10:34 UTC

Requires

• php: >=7.3
• agungsugiarto/codeigniter4-cors: ^v2.0.0
• myth/auth: ^v1.0.1

Requires (Dev)

• codeigniter4/framework: ^v4.2.1

MIT

• Meksi Abdou

• api
• Authentication
• restful
• codeigniter

README

CodeIgniter 4 RESTful & Auth Api

CodeIgniter 4 RESTful & Auth Api Resource Base Controller

This RESTful API extension is collected into composer require meksiabdou/ci4-restful which is a complete solution for Codeigniter framework.

Features

• Auth use package myth/auth

• RESTful API implementation

• Logs Requests

OUTLINE

• Demonstration
  • RESTful Create Function
• Requirements
• Installation
• Configuration

DEMONSTRATION

use CI4Restful\Helpers\RestServer;

class ApiController extends RestServer
{
    public function index()
    {
        return $this->response_json(["id" => 1, "bar" => "foo" ]], true);
    }
}

Output with status 200 OK:

{
    "results" : {
        "id": 1,
        "bar" : "foo",
    },
    "status" : true,
}

RESTful Create Function

public function store($requestData=null) {

    $this->db->insert('mytable', $requestData);
    $id = $this->db->insert_id();
    
    return $this->response->json(['id'=>$id], true , 201);
}

Output with status 201:

{
    "results" : {
        "id": 1,
    },
    "status" : true,
}

Output with error

public function store($requestData=null) {

    if(!$requestData) {
        return $this->response->json([], false );
    }
    
}

{
    "results" : {},
    "status" : false,
}

Output with status 403 Forbidden:

{
    "code": 403,
    "error":"API forbidden", 
    "status" : false
}

REQUIREMENTS

This library requires the following:

• PHP 7.4+
• CodeIgniter 4+
• agungsugiarto/codeigniter4-cors
• myth/auth

INSTALLATION

Run Composer in your Codeigniter project:

composer require meksiabdou/ci4-restful

CONFIGURATION

Config CORS agungsugiarto/codeigniter4-cors

To allow CORS for all your routes, first register CorsFilter.php filter at the top of the $aliases property of App/Config/Filter.php class:

public $aliases = [
    'cors' => \Fluent\Cors\Filters\CorsFilter::class,
    // ...
];

Restrict routes based on their URI pattern by editing app/Config/Filters.php and adding them to the $filters array,

public filters = [
    // ...
    'cors' => ['after' => ['api/*']],
];

Config Public Token

To access public routes generate token and add $token_app to app\Config\App.php

class App extends BaseConfig {

	public $token_app = ['2ve7Wq9P2QLnzQMlN2uVnBfb10xvOY0NQTuQ7Q'];

   //...

Create a controller to extend CI4Restful\Helpers\RestServer,

class Store extends RestServer {}

Restful Auth API

https://yourname.com/api/login (POST)
https://yourname.com/api/register (POST)
https://yourname.com/api/logout (POST)
https://yourname.com/api/forgot-password (POST)
https://yourname.com/api/reset-password (POST)
https://yourname.com/api/update-user (PUT)
https://yourname.com/api/resend-activate-account (PUT)
https://yourname.com/api/p/update (for update password) (POST)

HttpRequest (public routes)

const formData = new FormData();
formData.append('identity', '[e-mail]')
formData.append('password', 'password123');
var requestOptions = {
  method: 'POST',
  headers: {
    "token" : "2ve7Wq9P2QLnzQMlN2uVnBfb10xvOY0NQTuQ7Q"
   },
  body: formData, 
  redirect: 'follow'
};

fetch("https://yourname.com/api/login", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

HttpRequest (private route)

const formData = new FormData();
formData.append('email', '[e-mail]')
formData.append('password', 'password123');
formData.append('newPassword', 'newPassword123');
formData.append('confirmPassword', 'newPassword123');

var requestOptions = {
  method: 'PUT',
  headers: {
    "token" : userToken,
   },
   body: formData, 
  redirect: 'follow'
};

fetch("https://yourname.com/p/update", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));