2013-01-01 18:27:41 +01:00
|
|
|
REST handlers
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
Purpose
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
REST is a set of constraints that, when applied to HTTP, dictates how
|
|
|
|
|
resources must behave. It is the recommended way to handle requests
|
|
|
|
|
with Cowboy.
|
|
|
|
|
|
|
|
|
|
REST is implemented in Cowboy as a protocol upgrade. Once upgraded,
|
|
|
|
|
the request is handled as a state machine with many optional callbacks
|
|
|
|
|
describing the resource and modifying the machine's behavior.
|
|
|
|
|
|
2013-02-11 09:26:13 +01:00
|
|
|
As the REST handler is still subject to change, the documentation is
|
|
|
|
|
still thin. This state of affair will be improved in the coming weeks.
|
|
|
|
|
|
2013-01-01 18:27:41 +01:00
|
|
|
Flow diagram
|
|
|
|
|
------------
|
|
|
|
|
|
2013-02-11 09:26:13 +01:00
|
|
|
Not done yet. Feel free to use the one that is currently being worked on.
|
|
|
|
|
|
|
|
|
|
* https://github.com/extend/cowboy/pull/364
|
2013-01-01 18:27:41 +01:00
|
|
|
|
|
|
|
|
Callbacks
|
|
|
|
|
---------
|
|
|
|
|
|
2013-02-11 09:26:13 +01:00
|
|
|
Please see the Webmachine documentation at this time.
|
2013-01-01 18:27:41 +01:00
|
|
|
|
|
|
|
|
Usage
|
|
|
|
|
-----
|
|
|
|
|
|
2013-02-11 09:26:13 +01:00
|
|
|
Please see the examples at this time.
|
