Add response documentation

This commit is contained in:
messense 2017-03-12 14:17:41 +08:00
parent af398fc4c4
commit d174917a07
No known key found for this signature in database
GPG Key ID: BB41A8A2C716CCA9
2 changed files with 100 additions and 0 deletions

View File

@ -9,6 +9,7 @@ Guides
sanic/getting_started
sanic/routing
sanic/request_data
sanic/response
sanic/static_files
sanic/exceptions
sanic/middleware

99
docs/sanic/response.md Normal file
View File

@ -0,0 +1,99 @@
# Response
Use functions in `sanic.response` module to create responses.
- `text` - Plain text response
```python
from sanic import response
@app.route('/text')
def handle_request(request):
return response.text('Hello world!')
```
- `html` - HTML response
```python
from sanic import response
@app.route('/html')
def handle_request(request):
return response.html('<p>Hello world!</p>')
```
- `json` - JSON response
```python
from sanic import response
@app.route('/json')
def handle_request(request):
return response.json({'message': 'Hello world!'})
```
- `file` - File response
```python
from sanic import response
@app.route('/file')
async def handle_request(request):
return await response.file('/srv/www/whatever.png')
```
- `stream` - Streaming response
```python
from sanic import response
@app.route("/streaming")
async def index(request):
async def streaming_fn(response):
await response.write('foo')
await response.write('bar')
return response.stream(streaming_fn, content_type='text/plain')
```
- `redirect` - Redirect response
```python
from sanic import response
@app.route('/redirect')
def handle_request(request):
return response.redirect('/json')
```
- `raw` - Raw response, response without encoding the body
```python
from sanic import response
@app.route('/raw')
def handle_request(request):
return response.raw('raw data')
```
To modify headers or status code, pass the `headers` or `status` argument to those functions:
```python
from sanic import response
@app.route('/json')
def handle_request(request):
return response.json(
{'message': 'Hello world!'},
headers={'X-Served-By': 'sanic'},
status=200
)
```