Lightweight PHP REST Framework
Switch branches/tags
Nothing to show
Pull request Compare This branch is even with deepeshmalviya:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
src
changelog.md
readme.md

readme.md

Simple-REST - PHP REST Library (v1.0)

Simple-REST is a lightweight PHP based REST library which can quickly enable RESTfulness in your application. It does all the Request/Response processing and can return response in multiple formats like JSON, XML and QUERYSTRING. The Simple-REST is licensed under the Apache Licence, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.html)

Requirement

Apache mod_rewrite support. PHP XMLWriter extension.

Notes

  • Following is the directory structure to be followed to use this library properly.

Support your url is http://example.com which is mapped to /var/www on your server then to have rest uri http://example.com/rest/test, you need to upload the files in src folder to /var/www/rest folder. The controllers should go in /var/www/rest/Controllers folder. Currently only one level of api is supported

  • The .htaccess converts the rest uri /rest/test?a=123 into /rest/index.php?RESTurl=test&a=123. This will load and execute methods from Controllers/Test.php based on HTTP request method.
  • This library follows Zend convention of path mapping. For e.g. Controllers_Test will look for Controllers/Test.php
  • Controllers directory is required.
  • The controller file name should be equal to rest resource uri. For e.g. for REST uri /rest/test, there should be Controllers/Test.php
  • The controller class name should have Controllers_ prefix.
  • The controller class should extend RestController. RestController is defined in Rest.php.

For e.g.

class Controllers_Test extends RestController {	}
  • Suppose, you only want to enable POST method for a REST api and disable other methods (GET/PUT/DELETE). In that case the disabled methods should return null.

For e.g.

class Controllers_Test extends RestController {
	public function get() {
		return null;
	}

	public function post() {
		$this->response = array('TestResponse' => 'MyResponse');
		$this->responseStatus = 200;
	}

	public function put() {
		return null;
	}

	public function delete() {
		return null;
	}
}
  • The functions get, post, put, delete methods of a controller maps to the HTTP GET, POST, PUT, DELETE respectively.
  • The $this->response and $this->responseStatus variables should be mandatorily populated by a enabled api method. $this->response will be the response body and $this->responseStatus will be the HTTP response status. $this->response should be in associative array format and there should be always one and only key in the immediate first parent. The reason for having one key in the parent is because in xml response this key will become the root node for the xml. The nesting level of the response array can go to any level.

For e.g.

$this->response = array('root' => array('xyz' => '123', 'abc' => '567'));

  • For XML based responses, in case of integer keys in the response array, its parent key will be taken and will be suffixed with the integer index to form the nodename in the response.

For e.g.

$this->response = array('root' => array('xyz' => '123', 'abc' => array('567','890')));

will be converted to

<?xml version="1.0" encoding="UTF-8"?> <root> <xyz>123</xyz> <abc> <abc0>567</abc0> <abc1>456</abc1> </abc> </root>

  • There is a special hook method checkAuth() which is called before executing any methods in the controller. This method can be overloaded in the controllers extending RestController to provide Authentication and Authorization for your REST webservice. The return value of this method should be true or false. The default return value of this method is true which makes all the REST resources public. In case of false, the REST service will generate a 401 Unauthorized response to the user.

Usage

Look in the examples folder for the implementation details.

To test the examples, run the following curl commands in shell after uploading folder to your localhost document root.

Feedback

File bugs or other issues here.