Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 2.73 KB

README.md

File metadata and controls

65 lines (39 loc) · 2.73 KB
Raw

CodeIgniter RestFull Automatic

Do you think repetivo having to create all standards methods for all tables to make a Restfull mapping?

Welcome this is CodeIgniter Restfull Automatic.

See the below its Advantages:

A full implementation Restfull GET, PUT, POST, DELETE, automatic

Requirements

  1. PHP 5.2 or greater
  2. CodeIgniter 2.1.0 to 3.0-dev

Note: for 1.7.x support download v2.2 from Downloads tab

Installation

Drag and drop the application/libraries/Format.php, application/libraries/REST_Controller.php,application/core/MY_Controller.php and application/core/MY_Model.php files into your application's directories. To use require_once it at the top of your controllers to load it into the scope. Additionally, copy the rest.php file from application/config in your application's configuration directory. More information visit

The author chriskacerguis: https://github.com/chriskacerguis/codeigniter-restserver

Handling Requests

To make requests, you must create within the Implementation Legislation application/controllers/api a file with the name of the Table NameTable.php, the database to which you want to capture or handle the data.

Once this is done, create a class following the pattern of CodeIgniter, with the following code:

class NameTable extends REST_Controller
{
    //Constructor Default
    public function __construct()
    {
    	parent::__construct( get_class($this) );

    }
}

Note: The table which you are mapping should have a Primary Key or Unico field called ID, otherwise you must recreate the method get or update with the new primary key.

There, only with this code, you already will have a Restfull API, with GET, INSERT, DELETE, UPDATE.

You can create new methods in this class following the pattern of our friend chriskacerguis, where it has a very good API, where it was developed using his work.

Requests

To make requests, simply call as follows:

http://example.com/index.php/api/NameTable/           GETALL
http://example.com/index.php/api/NameTable/query/id/1 GET 
http://example.com/index.php/api/NameTable/           POST	
http://example.com/index.php/api/NameTable/query/id/1 PUT 
http://example.com/index.php/api/NameTable/query/id/1 DELETE

Note: The word query can be replaced by any word, staying for example set:.

http://example.com/index.php/api/Operators/Operator/id/1 GET
http://example.com/index.php/api/Operators/Operator/id/1 PUT
http://example.com/index.php/api/Operators/Operator/id/1 DELETE

Contributions

This project was developed based on the code written by chriskacerguis. Just created a way to make the standard methods of requests, a little easier to be implemented, while taking the complexity and usability of other methods.