Vasanko/sanic
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Merge pull request #551 from messense/feature/documentation-links

Browse Source 
Add hyperlinks in response documentation
This commit is contained in:
Raphael Deem 2017-03-13 17:00:00 -07:00 committed by GitHub
commit 9a3fac90e1
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/sanic/response.md
View File

@ -2,7 +2,7 @@
Use functions in `sanic.response` module to create responses. Use functions in `sanic.response` module to create responses.
- `text` - Plain text response ## Plain Text
```python ```python
from sanic import response from sanic import response
@ -13,7 +13,7 @@ def handle_request(request):
return response.text('Hello world!') return response.text('Hello world!')
``` ```
- `html` - HTML response ## HTML
```python ```python
from sanic import response from sanic import response
@ -24,7 +24,7 @@ def handle_request(request):
return response.html('<p>Hello world!</p>') return response.html('<p>Hello world!</p>')
``` ```
- `json` - JSON response ## JSON
```python ```python
@ -36,7 +36,7 @@ def handle_request(request):
return response.json({'message': 'Hello world!'}) return response.json({'message': 'Hello world!'})
``` ```
- `file` - File response ## File
```python ```python
from sanic import response from sanic import response
@ -47,7 +47,7 @@ async def handle_request(request):
return await response.file('/srv/www/whatever.png') return await response.file('/srv/www/whatever.png')
``` ```
- `stream` - Streaming response ## Streaming
```python ```python
from sanic import response from sanic import response
@ -60,7 +60,7 @@ async def index(request):
return response.stream(streaming_fn, content_type='text/plain') return response.stream(streaming_fn, content_type='text/plain')
``` ```
- `redirect` - Redirect response ## Redirect
```python ```python
from sanic import response from sanic import response
@ -71,7 +71,9 @@ def handle_request(request):
return response.redirect('/json') return response.redirect('/json')
``` ```
- `raw` - Raw response, response without encoding the body ## Raw
Response without encoding the body
```python ```python
from sanic import response from sanic import response
@ -82,6 +84,7 @@ def handle_request(request):
return response.raw('raw data') return response.raw('raw data')
``` ```
## Modify headers or status
To modify headers or status code, pass the `headers` or `status` argument to those functions: To modify headers or status code, pass the `headers` or `status` argument to those functions: