aboutsummaryrefslogtreecommitdiffstats
path: root/guide/rest_handlers.md
blob: df5f841ccced4f935f4003023142d0ffa7fdd5f2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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.

Flow diagram
------------

@todo Add the beautiful flow diagram here.

Callbacks
---------

@todo Describe the callbacks.

Usage
-----

@todo Explain how to use them.