Commits

Justin Sheehy committed 2f9a384

Automated commit message

Comments (0)

Files changed (1)

WebmachineResources.wiki

+All webmachine resources should include the webmachine resource library:
+
+{{{#!erlang
+-include_lib("webmachine/include/webmachine.hrl").
+}}}
+
+All webmachine resources should define and export {{{init/1}}}, which will receive a configuration property list from the dispatcher as its argument. This function should, if successful, return {{{ {ok, Context} }}}. Context is any term, and will be threaded through all of the other webmachine resource functions.  Alternately, the resource can go into debugging mode by returning {{{ {{trace, Dir}, Context} }}} instead -- see [[DebuggingResources]] for more information on tracing.
+
+All webmachine resource functions are of the signature:
+
+{{{#!erlang
+f(ReqData, Context) -> {Result, ReqData, Context}
+}}}