Download the PHP package scorpjio/zf3-rest-api without Composer
On this page you can find all versions of the php package scorpjio/zf3-rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download scorpjio/zf3-rest-api
More information about scorpjio/zf3-rest-api
Files in scorpjio/zf3-rest-api
Package zf3-rest-api
Short Description Zend Framework 3 module to build REST APIs
License MIT
Homepage https://github.com/scorpjio/zf3-rest-api
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 zf3-rest-api
RestApi module for Zend Framework 3
(this is a removed repository from https://github.com/multidots)
Requirements
This module has the following requirements:
- Zend Framework 3 or greater.
- PHP 7 or greater.
Installation
You can install this module into your Zend Framework application using composer.
The recommended way to install composer packages is:
Now copy this file "vendor/scorpjio/zf3-rest-api/config/restapi.global.php" and paste to root "config/autoload/restapi.global.php"
If you do not setup at the time of package installation then 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 module provides several configurations 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 a presence of auth token in API request. You need to define a flag isAuthorizationRequired to true or false. For example,
Above API method will require an auth token in a request. You can pass the auth token in either header, in GET parameter or in POST field.
If you want to pass token in a header, use below format.
In a case of GET or POST parameter, pass the token in token parameter.
Generate jwt token
This module provides methods to generate jwt token and sign with same key and algorithm. Use $this->generate() method wherever required. Most probably, you will need this in to user login and register API. See below example,
Response format
The response format of API is json and its structure is defined as below.
Examples
Below one example to understand how this module 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,
Reporting Issues
If you have a problem with this module or any bug, please open an issue on GitHub.
