From: Jun-Ah 준아 Date: Thu, 15 Aug 2024 22:38:02 +0000 (+0900) Subject: 📝 Add missing `compresslevel` parameter on docs for `GZipMiddleware` (#11350) X-Git-Tag: 0.112.2~65 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=265dbeb6635864e527cfd4c7376f0b32bc2301c1;p=thirdparty%2Ffastapi%2Ffastapi.git 📝 Add missing `compresslevel` parameter on docs for `GZipMiddleware` (#11350) Co-authored-by: Sebastián Ramírez --- diff --git a/docs/en/docs/advanced/middleware.md b/docs/en/docs/advanced/middleware.md index 4b273fd897..57e4761673 100644 --- a/docs/en/docs/advanced/middleware.md +++ b/docs/en/docs/advanced/middleware.md @@ -88,6 +88,7 @@ The middleware will handle both standard and streaming responses. The following arguments are supported: * `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 diff --git a/docs_src/advanced_middleware/tutorial003.py b/docs_src/advanced_middleware/tutorial003.py index b99e3edd19..e2c87e67d8 100644 --- a/docs_src/advanced_middleware/tutorial003.py +++ b/docs_src/advanced_middleware/tutorial003.py @@ -3,7 +3,7 @@ from fastapi.middleware.gzip import GZipMiddleware app = FastAPI() -app.add_middleware(GZipMiddleware, minimum_size=1000) +app.add_middleware(GZipMiddleware, minimum_size=1000, compresslevel=5) @app.get("/")