diff options
author | Loïc Hoguin <[email protected]> | 2013-01-01 18:27:41 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2013-01-01 18:27:41 +0100 |
commit | 06e74355c0a993b416b21bb4e9586c37973e8d83 (patch) | |
tree | bb70dc2d6369637d5663c01e031f3da875eb3dc9 /guide/rest_handlers.md | |
parent | 2690d1254caffa2d85965baf95ed005c39fc820a (diff) | |
download | cowboy-06e74355c0a993b416b21bb4e9586c37973e8d83.tar.gz cowboy-06e74355c0a993b416b21bb4e9586c37973e8d83.tar.bz2 cowboy-06e74355c0a993b416b21bb4e9586c37973e8d83.zip |
Add a skeleton of the guide to ease user contributions
Has some stuff that aren't in master yet, and lacks a lot more
that is already in master.
Diffstat (limited to 'guide/rest_handlers.md')
-rw-r--r-- | guide/rest_handlers.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/guide/rest_handlers.md b/guide/rest_handlers.md new file mode 100644 index 0000000..df5f841 --- /dev/null +++ b/guide/rest_handlers.md @@ -0,0 +1,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. |