Download the PHP package sprintcube/cakephp-rest without Composer
On this page you can find all versions of the php package sprintcube/cakephp-rest. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sprintcube/cakephp-rest
More information about sprintcube/cakephp-rest
Files in sprintcube/cakephp-rest
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package cakephp-rest
Rest Plugin for CakePHP
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.
The recommended way to install composer packages is:
After installation, Load the plugin
Or, you can load the plugin using the shell command
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,
And extend your controller to RestController and everything will be handled by the plugin itself. For example,
And that's it. You will see the response as below.
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.
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,
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.
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().
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,
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.
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.
