5/2/2021 chriskacerguis/codeigniter-restserver: A fully RESTful server implementation for CodeIgniter using one library, one c…

chriskacerguis / codeigniter-restserver

A fully RESTful server implementation for CodeIgniter using one library, one config file and one
controller.

MIT License

4.7k stars 2.8k forks

Star Watch

Code Issues 6 Pull requests 1 Actions Projects Security Insights

master

chriskacerguis … on Feb 28

View code

CodeIgniter RestServer
StyleCI passed

A fully RESTful server implementation for CodeIgniter using one library, one config file and
one controller.

Requirements
PHP 7.2 or greater
CodeIgniter 3.1.11+

Installation
README.md
composer require chriskacerguis/codeigniter-restserver

Usage

https://github.com/chriskacerguis/codeigniter-restserver 1/4
5/2/2021 chriskacerguis/codeigniter-restserver: A fully RESTful server implementation for CodeIgniter using one library, one c…

CodeIgniter Rest Server is available on Packagist (using semantic versioning), and

installation via composer is the recommended way to install Codeigniter Rest Server. Just
add this line to your composer.json file:

"chriskacerguis/codeigniter-restserver": "^3.1"

or run

composer require chriskacerguis/codeigniter-restserver

Note that you will need to copy rest.php to your config directory (e.g.
application/config )

Step 1: Add this to your controller (should be before any of your code)

use chriskacerguis\RestServer\RestController;

Step 2: Extend your controller

class Example extends RestController

Basic GET example

Here is a basic example. This controller, which should be saved as Api.php , can be called
in two ways:

http://domain/api/users/ will return the list of all users

http://domain/api/users/id/1 will only return information about the user with id = 1

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

use chriskacerguis\RestServer\RestController;

class Api extends RestController {

function __construct()
{
// Construct the parent class
parent::__construct();
}

public function users_get()

{

https://github.com/chriskacerguis/codeigniter-restserver 2/4
5/2/2021 chriskacerguis/codeigniter-restserver: A fully RESTful server implementation for CodeIgniter using one library, one c…

// Users from a data store e.g. database

$users = [
['id' => 0, 'name' => 'John', 'email' => 'john@example.com'],
['id' => 1, 'name' => 'Jim', 'email' => 'jim@example.com'],
];

$id = $this->get( 'id' );

if ( $id === null )

{
// Check if the users data store contains users
if ( $users )
{
// Set the response and exit
$this->response( $users, 200 );
}
else
{
// Set the response and exit
$this->response( [
'status' => false,
'message' => 'No users were found'
], 404 );
}
}
else
{
if ( array_key_exists( $id, $users ) )
{
$this->response( $users[$id], 200 );
}
else
{
$this->response( [
'status' => false,
'message' => 'No such user found'
], 404 );
}
}
}
}

Releases 21

Bug fixes Latest

on Nov 12, 2019

+ 20 releases

Packages
https://github.com/chriskacerguis/codeigniter-restserver 3/4
5/2/2021 chriskacerguis/codeigniter-restserver: A fully RESTful server implementation for CodeIgniter using one library, one c…

No packages published

Used by 1.3k

+ 1,328

Contributors 146

+ 135 contributors

Languages

PHP 98.2% HTML 1.8%

https://github.com/chriskacerguis/codeigniter-restserver 4/4