Download the PHP package ankitgs/restapi without Composer
On this page you can find all versions of the php package ankitgs/restapi. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ankitgs/restapi
More information about ankitgs/restapi
Files in ankitgs/restapi
Package restapi
Short Description Zend Framework 3 module to build REST APIs
License MIT
Homepage https://github.com/multidots/zf3-rest-api
Informations about the package restapi
RestApi plugin for Zend Framework 3
Requirements
This plugin has the following requirements:
- Zend Framework 3 or greater.
- PHP 7 or greater.
Installation
You can install this plugin into your Zend Framework application using composer.
The recommended way to install composer packages is:
After installation, go to root path and open composer.json file and add following.
Now Execute following command
Now copy this file "vender/restapi/config/restapi.global.php" and paste to root "config/autoload/restapi.global.php"
Now add this 'restapi' to modules.config.php file.
Usage
You just need to create your API related controller and extend it to ApiController
instead of default AbstractActionController
. You just need to set you results in apiResponse
variable and your response code in httpStatusCode
variable and return $this->createResponse(). 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 your module.config.php as following`.
Simple :)
Configurations
This plugin provides several configuration related to Response, Request and JWT
authentication. The default configurations are in previously you copy and past file this restapi.global.php have configurations`.
Request authentication using JWT
You can check for presence of auth token in API request. You need to define a flag isAuthorizationRequired
to true
or false
. For example,
json { "status": "OK", "result": { //your result data } } json { "status": "OK", "result": { "articles": [ { "id": 1, "title": "Lorem ipsum" }, { "id": 2, "title": "Donec hendrerit" } ] } }
## Reporting Issues
If you have a problem with this plugin or any bug, please open an issue on [GitHub](https://github.com/multidots/cakephp-rest-api/issues).