0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 20:50:24 +00:00
cowboy/guide/rest_handlers.md
Loïc Hoguin 06e74355c0 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.
2013-01-01 18:27:41 +01:00

28 lines
567 B
Markdown

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.