README

An API abstraction layer for CakePHP that includes API level exceptions

Background

Allows for an easy way to create a request data layer to normalize incoming data and includes exception classes for common error cases such as login, save and missing params.

Requirements

PHP >= 5.3
CakePHP 2.x
Basic knowledge of Exceptions in CakePHP

Installation

[Manual]

Download this: http://github.com/asugai/CakePHP-API-Manager/zipball/master
Unzip that download.
Copy the resulting folder to app/Plugin
Rename the folder you just copied to ApiManager

[GIT Submodule]

In your app directory type:

git submodule add git://github.com/asugai/CakePHP-API-Manager.git Plugin/ApiManager
git submodule update --init

[GIT Clone]

In your app directory type

git clone git://github.com/asugai/CakePHP-API-Manager.git Plugin/ApiManager

Enable plugin

Enable the plugin your app/Config/bootstrap.php file:

CakePlugin::load('ApiManager');

If you are already using CakePlugin::loadAll();, then this is not necessary.

Usage

Setup ApiManager

Setup the autoloader if you are using composer in /app/Config/bootstrap.php:

// Load composer autoload.
require APP . '/Vendor/autoload.php';

// Remove and re-prepend CakePHP's autoloader as composer thinks it is the most important.
// See https://github.com/composer/composer/commit/c80cb76b9b5082ecc3e5b53b1050f76bb27b127b
spl_autoload_unregister(array('App', 'load'));
spl_autoload_register(array('App', 'load'), true, true);

Optional: Edit /app/Config/bootstrap.php file and add ApiManager keys:

Configure::write('ApiManager.softErrors', false);
Configure::write('ApiManager.log', false);
Configure::write('ApiManager.legacy', false);
Configure::write('ApiManager.objectifyExclude', []);

Setup AppController to extend ApiController:

class AppController extends ApiController {
    ...
}

Create request models using ApiRequest as base, example created in /app/Request/User/UserLoginRequest.php:

class UserLoginRequest extends ApiRequest {
	const EMAIL = 'email';
    const PASSWORD = 'password';
    
	protected $map = [
		self::EMAIL,
        self::PASSWORD
	];

	protected $mandatory = [
		self::EMAIL => 'Email',
        self::PASSWORD => 'Password'
	];
    
	protected function afterCheckCallback() {
		parent::afterCheckCallback();
	}
}

Create normalization routing in controller:

App::uses('UserLoginRequest', 'Request/User');

class UsersController extends AppController
{
    ...
    
    public function api_login()
    {
        $this->api_DefaultFlow($this->User, 'api_login', 'UserLoginRequest');
    }
    
    ...
}

Use the normalized object in the model function:

class User extends AppModel
{
    ...
    
    public function api_login(\UserLoginRequest $request)
    {
		if (!$user = $this->findByEmailAndPassword(
            $request->email, 
            $request->password
        )) {
		    throw new ApiLoginException();
		}
    
		return $user;
    }
}

Todo

Comments!

Aknowledgements

The basic layout of this of this README was taken from https://github.com/dkullmann/CakePHP-Elastic-Search-DataSource

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

asugai / cake-php-api-manager

Maintainers

Details