Download the PHP package jeffersonsimaogoncalves/cakephp-rest-api without Composer
On this page you can find all versions of the php package jeffersonsimaogoncalves/cakephp-rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jeffersonsimaogoncalves/cakephp-rest-api
More information about jeffersonsimaogoncalves/cakephp-rest-api
Files in jeffersonsimaogoncalves/cakephp-rest-api
Package cakephp-rest-api
Short Description CakePHP 3 plugin to provide basic support for building REST API services
License MIT
Homepage https://github.com/jeffersonsimaogoncalves/cakephp-rest-api
Informations about the package cakephp-rest-api
RestApi plugin for CakePHP 3
This plugin provides basic support for building REST API services in your CakePHP 3 application. Read a detailed guide on how to implement this here - CakePHP: Build REST APIs with RestApi plugin
Requirements
This plugin has the following requirements:
- CakePHP 3.6.0 or greater.
- PHP 7.0 or greater.
Installation
You can install this plugin into your CakePHP application using composer.
The recommended way to install composer packages is:
After installation, Load the plugin
Or, you can load the plugin using the shell command
Usage
You just need to create your API related controller and extend it to ApiController
instead of default AppController
. You just need to set you results in apiResponse
variable and your response code in httpStatusCode
variable. For example,
You can define your logic in your action function as per your need. For above example, you will get following response in json
format,
The URL for above example will be http://yourdomain.com/foo/bar
. You can customize it by setting the routes in APP/config/routes.php
.
Simple :)
Configurations
This plugin provides several configuration related to Response Format, CORS
, Request Logging and JWT
authentication. The default configurations are as below and defined in RestApi/config/api.php
.
Set
debug
to true in your development environment to get original exception messages in response.
Request authentication using JWT
You can check for presence of auth token in API request. By default it is enabled. You need to define a flag allowWithoutToken
to true
or false
. For example,
Above API method will require auth token in request. You can pass the auth token in either header, in GET parameter or in POST field.
If you want to pass token in header, use below format.
In case of GET or POST parameter, pass the token in token
parameter.
Generate jwt token
This plugin provides Utility class to generate jwt token and sign with same key and algorithm. Use JwtToken::generate()
method wherever required. Most probably, you will need this in user login and register API. See below example,
cors
By default, cors requests are enabled and allowed from all domains. You can overwrite these settings by creating config file at APP/config/api.php
. The content of file will look like,
To disable cors request, set enabled
flag to false
. To allow requests from specific domains, set them in origin
option like,
Log request & response
By default, request log is disabled. You can overwrite this by creating/updating config file at APP/config/api.php
. The content of file will look like,
After enabling the log, you need to create a table in your database. Below is the table structure.
Or you can use the bake
command to automatically generate the above table.
Response format
The default response format of API is json
and its structure is defined as below.
If you have set httpResponseCode to any value other that 200, the status
value will be NOK
otherwise OK
. In case of exceptions, it will be handled automatically and set the appropriate status code.
You can modify the default response configuration like the text for OK response, key for main response data, etc. by overwriting them in your
APP/config/api.php
file.
Examples
Below are few examples to understand how this plugin works.
Retrieve articles
Let's create an API which returns a list of articles with basic details like id and title. Our controller will look like,
The response of above API call will look like,
Exception handling
This plugin will handle the exceptions being thrown from your action. For example, if you API method only allows POST
method and someone makes a GET
request, it will generate NOK
response with proper HTTP response code. For example,
The response will look like,
Another example of throwing an exception,
And the response will be,
Reporting Issues
If you have a problem with this plugin or any bug, please open an issue on GitHub.
Credits
This work is based on the code by vishal2995.
All versions of cakephp-rest-api with dependencies
cakephp/cakephp Version ^4.0
firebase/php-jwt Version >=v4.0.0
league/fractal Version >=0.13.0