Download the PHP package pejonic/cakephp-3-rest-api without Composer
On this page you can find all versions of the php package pejonic/cakephp-3-rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pejonic/cakephp-3-rest-api
More information about pejonic/cakephp-3-rest-api
Files in pejonic/cakephp-3-rest-api
Package cakephp-3-rest-api
Short Description CakePHP 3 plugin to provide basic support for building REST API services
License MIT
Homepage https://github.com/cakephp/debug_kit
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-3-rest-api
RestApi plugin for CakePHP 3
This plugin provides basic support for building REST API services in your CakePHP 3 application.
Requirements
This plugin has the following requirements:
- CakePHP 3.0.0 or greater.
- PHP 5.4.16 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
cors
As of now, this plugin provides configuration for CORS requests. 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,
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.
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.
