From 2fec2bf56041340bfad4f138c17147e356602f17 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sun, 14 Oct 2018 07:11:14 -0400 Subject: [PATCH] response headers --- docs/source/quickstart.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index b23b350..ef9f31d 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -92,3 +92,25 @@ Here, we'll process our data in the background, while responding immediately to resp.media = {'success': True} A ``POST`` request to ``/incoming`` will result in an immediate response of ``{'success': true}``. + + +Setting Response Status Code +---------------------------- + +If you want to set the response status code, simply set ``resp.status_code``:: + + @api.route("/416") + def teapot(req, resp): + resp.status_code = api.status_codes.HTTP_416 # ...or 416 + + +Setting Response Headers +------------------------ + +If you want to set a response header, like ``X-Pizza: 42``, simply modify the ``resp.headers`` dictionary: + + @api.route("/pizza") + def pizza_pizza(req, resp): + resp.headers['X-Pizza'] = 42 + +That's it!