.. ZF2 module for implementing RESTful JSON APIs in Hypermedia Application
   Language (HAL)

Welcome to PhlyRestfully!
=========================

PhlyRestfully is a `Zend Framework 2 <http://framework.zend.com>`_ module for
implementing RESTful JSON APIs in `Hypermedia Application Language (HAL)
<http://stateless.co/hal_specification.html>`_. It provides a workflow for
mapping persistence to resources to expose via your API.

For error reporting, it uses `API-Problem <http://tools.ietf.org/html/draft-nottingham-http-problem-02>`_.

Contents:

.. toctree::
   :hidden:
   
   halprimer
   problems
   options
   basics/index
   basics/resources
   basics/controllers
   basics/example
   ref/resource-event
   ref/controller-events
   ref/advanced-routing
   ref/advanced-rendering
   ref/hydrators
   ref/collections-and-pagination
   ref/embedding-resources
   ref/metadata-map
   ref/api-problem-listener
   ref/alternate-resource-return-values
   ref/child-resources
   ref/classes

RESTful JSON API Primer
-----------------------

    * :doc:`halprimer`
    * :doc:`problems`
    * :doc:`options`

PhlyRestfully Walkthrough
-------------------------

    * :doc:`basics/index`
    * :doc:`basics/resources`
    * :doc:`basics/controllers`
    * :doc:`basics/example`

Reference Guide
---------------

    * :doc:`ref/resource-event`
    * :doc:`ref/controller-events`
    * :doc:`ref/advanced-routing`
    * :doc:`ref/advanced-rendering`
    * :doc:`ref/hydrators`
    * :doc:`ref/collections-and-pagination`
    * :doc:`ref/embedding-resources`
    * :doc:`ref/metadata-map`
    * :doc:`ref/api-problem-listener`
    * :doc:`ref/alternate-resource-return-values`
    * :doc:`ref/child-resources`
    * :doc:`ref/classes`

Api docs:
---------

`API docs are available. <_static/phpdoc/index.html>`_


Indices and tables
==================

* :doc:`index`
* :ref:`genindex`
* :ref:`search`

