50 lines
1.7 KiB
Markdown
50 lines
1.7 KiB
Markdown
# Middleware
|
|
|
|
Middleware can be executed before or after requests. It is executed in the order it was registered. If middleware returns a response object, the request will stop processing and a response will be returned.
|
|
|
|
Middleware is registered via the middleware decorator, and can either be added as 'request' or 'response' middleware, based on the argument provided in the decorator. Response middleware receives both the request and the response as arguments.
|
|
|
|
## Examples
|
|
|
|
```python
|
|
app = Sanic(__name__)
|
|
|
|
@app.middleware
|
|
async def halt_request(request):
|
|
print("I am a spy")
|
|
|
|
@app.middleware('request')
|
|
async def halt_request(request):
|
|
return text('I halted the request')
|
|
|
|
@app.middleware('response')
|
|
async def halt_response(request, response):
|
|
return text('I halted the response')
|
|
|
|
@app.route('/')
|
|
async def handler(request):
|
|
return text('I would like to speak now please')
|
|
|
|
app.run(host="0.0.0.0", port=8000)
|
|
```
|
|
|
|
## Middleware chain
|
|
|
|
If you want to apply the middleware as a chain, applying more than one, is so easy. You only have to be aware that you do **not return** any response in your middleware:
|
|
|
|
```python
|
|
app = Sanic(__name__)
|
|
|
|
@app.middleware('response')
|
|
async def custom_banner(request, response):
|
|
response.headers["Server"] = "Fake-Server"
|
|
|
|
@app.middleware('response')
|
|
async def prevent_xss(request, response):
|
|
response.headers["x-xss-protection"] = "1; mode=block"
|
|
|
|
app.run(host="0.0.0.0", port=8000)
|
|
```
|
|
|
|
The above code will apply the two middlewares in order. First the middleware **custom_banner** will change the HTTP Response headers *Server* by *Fake-Server*, and the second middleware **prevent_xss** will add the HTTP Headers for prevent Cross-Site-Scripting (XSS) attacks.
|