zfcampus / zf-rest
ZF Module providing structure for RESTful resources
Installs: 1 868 489
Dependents: 28
Suggesters: 0
Security: 0
Stars: 33
Watchers: 20
Forks: 42
Open Issues: 11
Requires
- php: ^5.6 || ^7.0
- zendframework/zend-eventmanager: ^2.6.3 || ^3.0.1
- zendframework/zend-mvc: ^2.7.14 || ^3.0.2
- zendframework/zend-paginator: ^2.7
- zendframework/zend-stdlib: ^2.7.7 || ^3.0.1
- zfcampus/zf-api-problem: ^1.2.2
- zfcampus/zf-content-negotiation: ^1.2.1
- zfcampus/zf-hal: ^1.4
- zfcampus/zf-mvc-auth: ^1.4
Requires (Dev)
- phpunit/phpunit: ^5.7.27 || ^6.5.8 || ^7.1.5
- zendframework/zend-coding-standard: ~1.0.0
- zendframework/zend-escaper: ^2.5.2
- zendframework/zend-http: ^2.5.4
- zendframework/zend-inputfilter: ^2.7.2
- zendframework/zend-servicemanager: ^2.7.6 || ^3.1
- zendframework/zend-uri: ^2.5.2
- zendframework/zend-validator: ^2.8.1
- zendframework/zend-view: ^2.8.1
- dev-master / 1.5.x-dev
- dev-develop / 1.6.x-dev
- 1.5.0
- 1.4.0
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.1
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 1.0.0-beta3
- 1.0.0beta2
- 1.0.0beta1
- 0.9.1
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- dev-feature/readme-documentation
- dev-hotfix/remove-obsolete-content-type-code
- dev-hotfix/api-problem-response
This package is auto-updated.
Last update: 2020-01-20 17:31:05 UTC
README
Repository abandoned 2019-12-31
This repository has moved to laminas-api-tools/api-tools-rest.
Introduction
This module provides structure and code for quickly implementing RESTful APIs that use JSON as a transport.
It allows you to create RESTful JSON APIs that use the following standards:
- Hypermedia Application Language, aka HAL, used for creating JSON payloads with hypermedia controls.
- Problem Details for HTTP APIs, aka API Problem, used for reporting API problems.
Requirements
Please see the composer.json file.
Installation
Run the following composer
command:
$ composer require zfcampus/zf-rest
Alternately, manually add the following to your composer.json
, in the require
section:
"require": { "zfcampus/zf-rest": "^1.3" }
And then run composer update
to ensure the module is installed.
Finally, add the module name to your project's config/application.config.php
under the modules
key:
return [ /* ... */ 'modules' => [ /* ... */ 'ZF\Rest', ], /* ... */ ];
zf-component-installer
If you use zf-component-installer, that plugin will install zf-rest as a module for you.
Configuration
User Configuration
The top-level key used to configure this module is zf-rest
.
Key: Controller Service Name
Each key under zf-rest
is a controller service name, and the value is an array with one or more of
the following keys.
Sub-key: collection_http_methods
An array of HTTP methods that are allowed when making requests to a collection.
Sub-key: entity_http_methods
An array of HTTP methods that are allowed when making requests for entities.
Sub-key: collection_name
The name of the embedded property in the representation denoting the collection.
Sub-key: collection_query_whitelist
(optional)
An array of query string arguments to whitelist for collection requests and when generating links
to collections. These parameters will be passed to the resource class' fetchAll()
method. Any of
these parameters present in the request will also be used when generating links to the collection.
Examples of query string arguments you may want to whitelist include "sort", "filter", etc.
Starting in 1.5.0: if a input filter exists for the GET
HTTP method, its
keys will be merged with those from configuration.
Sub-key: controller_class
(optional)
An alternate controller class to use when creating the controller service; it must extend
ZF\Rest\RestController
. Only use this if you are altering the workflow present in the
RestController
.
Sub-key: identifier
(optional)
The name of event identifier for controller. It allows multiple instances of controller to react to different sets of shared events.
Sub-key: resource_identifiers
(optional)
The name or an array of names of event identifier/s for resource.
Sub-key: entity_class
The class to be used for representing an entity. Primarily useful for introspection (for example in the Apigility Admin UI).
Sub-key: route_name
The route name associated with this REST service. This is utilized when links need to be generated in the response.
Sub-key: route_identifier_name
The parameter name for the identifier in the route specification.
Sub-key: listener
The resource class that will be dispatched to handle any collection or entity requests.
Sub-key: page_size
The number of entities to return per "page" of a collection. This is only used if the collection
returned is a Zend\Paginator\Paginator
instance or derivative.
Sub-key: max_page_size
(optional)
The maximum number of entities to return per "page" of a collection. This is tested against the
page_size_param
. This parameter can be set to help prevent denial of service attacks against your API.
Sub-key: min_page_size
(optional)
The minimum number of entities to return per "page" of a collection. This is tested against the
page_size_param
.
Sub-key: page_size_param
(optional)
The name of a query string argument that will set a per-request page size. Not set by default; we recommend having additional logic to ensure a ceiling for the page size as well, to prevent denial of service attacks on your API.
User configuration example:
'AddressBook\\V1\\Rest\\Contact\\Controller' => [ 'listener' => 'AddressBook\\V1\\Rest\\Contact\\ContactResource', 'route_name' => 'address-book.rest.contact', 'route_identifier_name' => 'contact_id', 'collection_name' => 'contact', 'entity_http_methods' => [ 0 => 'GET', 1 => 'PATCH', 2 => 'PUT', 3 => 'DELETE', ], 'collection_http_methods' => [ 0 => 'GET', 1 => 'POST', ], 'collection_query_whitelist' => [], 'page_size' => 25, 'page_size_param' => null, 'entity_class' => 'AddressBook\\V1\\Rest\\Contact\\ContactEntity', 'collection_class' => 'AddressBook\\V1\\Rest\\Contact\\ContactCollection', 'service_name' => 'Contact', ],
System Configuration
The zf-rest
module provides the following configuration to ensure it operates properly in a Zend
Framework application.
'service_manager' => [ 'invokables' => [ 'ZF\Rest\RestParametersListener' => 'ZF\Rest\Listener\RestParametersListener', ], 'factories' => [ 'ZF\Rest\OptionsListener' => 'ZF\Rest\Factory\OptionsListenerFactory', ], ], 'controllers' => [ 'abstract_factories' => [ 'ZF\Rest\Factory\RestControllerFactory', ], ], 'view_manager' => [ // Enable this in your application configuration in order to get full // exception stack traces in your API-Problem responses. 'display_exceptions' => false, ],
ZF2 Events
Listeners
ZF\Rest\Listener\OptionsListener
This listener is registered to the MvcEvent::EVENT_ROUTE
event with a priority of -100
.
It serves two purposes:
- If a request is made to either a REST entity or collection with a method they do not support, it
will return a
405 Method not allowed
response, with a populatedAllow
header indicating which request methods may be used. - For
OPTIONS
requests, it will respond with a200 OK
response and a populatedAllow
header indicating which request methods may be used.
ZF\Rest\Listener\RestParametersListener
This listener is attached to the shared dispatch
event at priority 100
. The listener maps query
string arguments from the request to the Resource
object composed in the RestController
, as well
as injects the RouteMatch
.
ZF2 Services
Models
ZF\Rest\AbstractResourceListener
This abstract class is the base implementation of a Resource listener. Since
dispatching of zf-rest
based REST services is event driven, a listener must be constructed to
listen for events triggered from ZF\Rest\Resource
(which is called from the RestController
).
The following methods are called during dispatch()
, depending on the HTTP method:
create($data)
- Triggered by aPOST
request to a resource collection.delete($id)
- Triggered by aDELETE
request to a resource entity.deleteList($data)
- Triggered by aDELETE
request to a resource collection.fetch($id)
- Triggered by aGET
request to a resource entity.fetchAll($params = [])
- Triggered by aGET
request to a resource collection.patch($id, $data)
- Triggered by aPATCH
request to resource entity.patchList($data)
- Triggered by aPATCH
request to a resource collection.update($id, $data)
- Triggered by aPUT
request to a resource entity.replaceList($data)
- Triggered by aPUT
request to a resource collection.
ZF\Rest\Resource
The Resource
object handles dispatching business logic for REST requests. It composes an
EventManager
instance in order to delegate operations to attached listeners. Additionally, it
composes request information, such as the Request
, RouteMatch
, and MvcEvent
objects, in order
to seed the ResourceEvent
it creates and passes to listeners when triggering events.
Controller
ZF\Rest\RestController
This is the base controller implementation used when a controller service name matches a configured
REST service. All REST services managed by zf-rest
will use this controller (though separate
instances of it), unless they specify a controller_class option.
Instances are created via the ZF\Rest\Factory\RestControllerFactory
abstract factory.
The RestController
calls the appropriate method in ZF\Rest\Resource
based on the requested HTTP
method. It returns HAL payloads on success, and API
Problem responses on error.