happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

📝 Add missing `compresslevel` parameter on docs for `GZipMiddleware` (#11350) 

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
This commit is contained in:
Jun-Ah 준아 2024-08-16 07:38:02 +09:00 committed by GitHub
parent 4636c621a9
commit 265dbeb663
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/en/docs/advanced/middleware.md
View File

@ -88,6 +88,7 @@ The middleware will handle both standard and streaming responses.
The following arguments are supported: The following arguments are supported:
* `minimum_size` - Do not GZip responses that are smaller than this minimum size in bytes. Defaults to `500`. * `minimum_size` - Do not GZip responses that are smaller than this minimum size in bytes. Defaults to `500`.
* `compresslevel` - Used during GZip compression. It is an integer ranging from 1 to 9. Defaults to `9`. Lower value results in faster compression but larger file sizes, while higher value results in slower compression but smaller file sizes.
## Other middlewares ## Other middlewares

2
docs_src/advanced_middleware/tutorial003.py
View File

@ -3,7 +3,7 @@ from fastapi.middleware.gzip import GZipMiddleware
app = FastAPI() app = FastAPI()
app.add_middleware(GZipMiddleware, minimum_size=1000) app.add_middleware(GZipMiddleware, minimum_size=1000, compresslevel=5)
@app.get("/") @app.get("/")