codeigniter-restserver

by chriskacerguis

chriskacerguis /codeigniter-restserver

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

4.6K Stars 2.8K Forks Last release: 10 months ago (3.1.1) MIT License 901 Commits 21 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

CodeIgniter RestServer

StyleCI

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

composer require chriskacerguis/codeigniter-restserver

Usage

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
use chriskacerguis\RestServer\RestController;

class Api extends RestController {

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

public function users_get()
{
    // Users from a data store e.g. database
    $users = [
        ['id' => 0, 'name' => 'John', 'email' => '[email protected]'],
        ['id' => 1, 'name' => 'Jim', 'email' => '[email protected]'],
    ];

    $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 );
        }
    }
}

}

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.