Flask guide

Author: Colton Provias

docs/flask.rst

@@ -11,25 +11,54 @@ and frustrating.  Let's look at an example::
 
         app = Flask(__name__)
         db = SQLAlchemy(app)
-        FlaskJSONAPI(app, db)
+        api = FlaskJSONAPI(app, db)
 
 And after all that work, you should now have a full working API.
 
 Signals
 =======
 
+As Flask makes use of signals via Blinker, it would be appropriate to make use
+of them in the Flask module for SQLALchemy-JSONAPI.  If a signal receiver
+returns a value, it can alter the final response.
+
 on_request
 ----------
 
+Triggered before serialization::
+
+        @api.on_request.connect
+        def process_api_request(sender, method, endpoint, data, req_args):
+            # Handle the request
+
 on_success
 ----------
 
+Triggered after successful serialization::
+
+        @api.on_success.connect
+        def process_api_success(sender, method, endpoint, data, req_args, response):
+            # Handle the response dictionary
+
+
 on_error
 --------
 
+Triggered after failed handling::
+
+        @api.on_error.connect
+        def process_api_error(sender, method, endpoint, data, req_args, error):
+            # Handle the error
+
 on_response
 -----------
 
+Triggered after rendering of response::
+
+        @api.on_response.connect
+        def process_api_response(sender, method, endpoint, data, req_args, rendered_response):
+            # Handle the rendered response
+
 API
 ===