https://github.com/sprintcube/cakephp-rest
CakePHP REST Plugin - Easily build REST API endpoints in your CakePHP application.
https://github.com/sprintcube/cakephp-rest
api cakephp cakephp-plugin rest rest-api
Last synced: 3 months ago
JSON representation
CakePHP REST Plugin - Easily build REST API endpoints in your CakePHP application.
- Host: GitHub
- URL: https://github.com/sprintcube/cakephp-rest
- Owner: sprintcube
- License: mit
- Created: 2018-04-10T09:28:47.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-26T21:14:22.000Z (over 5 years ago)
- Last Synced: 2025-09-18T00:54:22.377Z (4 months ago)
- Topics: api, cakephp, cakephp-plugin, rest, rest-api
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 25
- Watchers: 9
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rest Plugin for CakePHP
[](https://travis-ci.org/sprintcube/cakephp-rest)
[](https://raw.githubusercontent.com/sprintcube/cakephp-rest/master/LICENSE)
[](https://packagist.org/packages/sprintcube/cakephp-rest)
[](https://packagist.org/packages/sprintcube/cakephp-rest)
This plugin simplifies the REST API development for your CakePHP 3 application. It simply converts the output of your controller into a JSON response.
## Installation
You can install this plugin into your CakePHP application using [composer](http://getcomposer.org).
The recommended way to install composer packages is:
```
composer require sprintcube/cakephp-rest
```
After installation, [Load the plugin](http://book.cakephp.org/3.0/en/plugins.html#loading-a-plugin)
```php
Plugin::load('Rest', ['bootstrap' => true]);
```
Or, you can load the plugin using the shell command
```sh
$ bin/cake plugin load -b Rest
```
## Usage
No major change requrires in the way you code in your CakePHP application. Simply, just add one parameter to your route configuration `isRest` like,
```php
$routes->connect('/foo/bar', ['controller' => 'Foo', 'action' => 'bar', 'isRest' => true]);
```
And extend your controller to `RestController` and everything will be handled by the plugin itself. For example,
```php
[
'dhikanu',
'tamburo'
]
];
$this->set(compact('bar'));
}
}
```
And that's it. You will see the response as below.
```json
{
"status": "OK",
"result": {
"bar": {
"falanu": [
"dhikanu",
"tamburo"
]
}
}
}
```
Doesn't it too simple? Whatever `viewVars` you set from your controller's action using `set()` method, will be converted into JSON response.
### Response Format
This plugin returns the response in the following format.
```json
{
"status": "OK",
"result": {
...
}
}
```
The `status` key may contain OK or NOK based on your response code. For all successful responses, the code will be 200 and the value of this key will be OK.
In case of error or exception, the value of `status` will become NOK. Also, based on your application's `debug` setting, it will contain the exception and trace data.
The `result` key contains the actual response. It holds all the variables set from your controller. This key will not be available in case of error/exception.
## Require Authentication??
This plugin also provides an option to authenticate request using JWT. Simply, just add one more parameter to your route configuration `requireAuthorization` like,
```php
$routes->connect('/foo/bar', ['controller' => 'Foo', 'action' => 'bar', 'isRest' => true, 'requireAuthorization' => true]);
```
Now, the plugin will check for the JWT token in the request in form of a header, query parameter or post data. If you want to pass the token in the header, use the following format.
```
Authorization: Bearer [token]
```
And for query parameter or post data, use `token` parameter and set the token as a value of the parameter.
### Generate a token
If you require the authentication in API, you first must grant the token to the user who is making the API request. In general, when a user logs in, the response should contain the token for all next requests.
To generate a token, use the method from Utility class of the plugin: `JwtToken::generate()`.
```php
/**
* login method
*
* @return Response|void
*/
public function login()
{
// you user authentication code will go here, you can compare the user with the database or whatever
$payload = [
'id' => "Your User's ID",
'other' => "Some other data"
];
$token = \Rest\Utility\JwtToken::generate($payload);
$this->set(compact('token'));
}
```
And it will return the token in response. So, in next API calls, a user can use that token for authorization. You can add whatever data is required in your payload.
By default, the plugin uses the predefined key and algorithm to generate JWT token. You can update this configuration by creating `config/rest.php` file. The content of this configuration file will be as following,
```php
[
'jwt' => [
'key' => 'PUT YOUR KEY HERE', // it should contain alphanumeric string with symbols
'algorithm' => 'HS256' // See https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40
]
]
];
```
### Access token data
If there is a valid token available in the request, you can access it in your controller using the `token` and `payload` properties.
```php
/**
* view method
*
* @return Response|void
*/
public function view()
{
$token = $this->token;
$payload = $this->payload;
// your action logic...
}
```
These properties are also available in your controller's `beforeFilter` method, so you can put additional authentication logic there.
## Reporting Issues
If you have a problem with this plugin or found any bug, please open an issue on [GitHub](https://github.com/sprintcube/cakephp-rest/issues).