/zfr-rest

A module for Zend Framework 2 that aims to simplify RESTful

Primary LanguagePHP

ZfrRest

Build Status Coverage Status Dependency Status

Version 0.1.0 (changelog)

READ MORE ABOUT CURRENT STATUS

Is ZfrRest usable ?

Current features of ZfrRest work well and ZfrRest is definitely usable for simple cases. However, please note that we have many more features to come for more complex applications. Those changes may (well, for sure they will) break the API at some point, but we will keep track of all the changes in the UPGRADE guide.

Ultimately, you are strongly encouraged to test the module and report feedbacks, PR...

Milestone

Here is a basic roadmap of ZfrRest, by priority:

  1. Finish the work on the ResourceGraphRoute, especially the assemble method.
  2. Better architecture for extracting/hydrating data, to especially allow to configure key names, payload structure... (so that integrate ZfrRest with a MVC framework that has specific conventions to be as easy as write an adapter).
  3. Add support for HATEOAS links.
  4. Improve the performance (using proxy maybe useful in some places)
  5. Cleanup the code

Installation

Install the module by typing (or add it to your composer.json file):

php composer.phar require zfr/zfr-rest

Then, add the keys "ZfrRest" to your modules list in application.config.php file, and copy-paste the file zfr_rest.local.php.dist into your autoload folder (don't forget to remove the .dist extension at the end!). For more details about how to use ZfrRest, please follow the quick start.

Documentation