FastAPI میں middleware کیسے کام کرتا ہے?

Question

Accepted Answer

**Middleware** FastAPI میں وہ کوڈ ہے جو **ہر request اور response** کے لیے چلتا ہے — اپنے endpoints کو wrap کرتے ہوئے logging، timing، CORS، اور headers شامل کرنے جیسے cross-cutting concerns کو سنبھالتا ہے۔ FastAPI Starlette کے middleware system کو استعمال کرتا ہے (یہ ASGI-based ہے)۔

## Custom middleware لکھنا

```python
import time

@app.middleware("http")
async def add_timing(request: Request, call_next):
    start = time.time()
    response = await call_next(request)        # call the endpoint (and any inner middleware)
    response.headers["X-Process-Time"] = str(time.time() - start)   # modify the response
    return response
```

Pattern یہ ہے: `await call_next(request)` سے پہلے کوڈ **اندر** (endpoint سے پہلے) چلتا ہے، `call_next` endpoint کو invoke کرتا ہے، اور اس کے بعد کوڈ **باہر** (response کو modify کرتے ہوئے) چلتا ہے۔ یہ ہر request کو wrap کرتا ہے — یہاں، تمام responses میں ایک timing header شامل کر رہے ہیں۔

## Request/response flow

```text
Request  → MW1 → MW2 → endpoint
Response ← MW1 ← MW2 ← endpoint
Middleware wraps the endpoint; runs in order on the way in, reverse on the way out.
```

## Built-in / عام middleware

```python
from fastapi.middleware.cors import CORSMiddleware
from fastapi.middleware.gzip import GZipMiddleware

app.add_middleware(CORSMiddleware, allow_origins=["https://app.example.com"], ...)  # CORS
app.add_middleware(GZipMiddleware, minimum_size=1000)                               # compression
```

Middleware عام طور پر `add_middleware` کے ذریعے شامل کیا جاتا ہے — CORS (cross-origin requests کو اجازت دینا)، GZip (responses کو compress کرنا)، اور trusted-host checks عام built-ins ہیں۔

## Middleware کے عام استعمالات

```text
✓ Logging / request timing / metrics
✓ CORS (cross-origin request handling)
✓ Adding security or custom headers
✓ Response compression (GZip)
✓ Request ID / correlation ID injection
```

## Middleware بمقابلہ dependencies

```text
Middleware   → runs for ALL requests; works at the raw request/response level (headers,
               timing, the whole response). Best for truly global concerns.
Dependencies → per-endpoint (or grouped) logic with access to parsed params, DI, and
               typed values. Best for auth, validation, shared parameters.
→ Use middleware for global cross-cutting concerns; dependencies for endpoint logic.
```

## یہ کیوں اہم ہے

Middleware FastAPI میں **عام، cross-cutting concerns** کا صحیح طریقہ ہے — logic جو ہر request اور response پر لاگو ہونا چاہیے، جیسے logging، request timing، CORS، compression، اور custom headers۔

اسے سمجھنا applications کو صحیح طریقے سے ڈھانچہ دینے کے لیے اہم ہے: middleware تمام endpoints کو wrap کرتا ہے (پہلے اور بعد میں چلتے ہوئے، دونوں request اور response کو modify کرنے کی صلاحیت کے ساتھ)، اسے app-wide behavior کے لیے مثالی بناتا ہے جو ہر endpoint میں دہرایا جانا مشکل اور غلطی کا شکار ہوگا۔

**Middleware** (عام، خام request/response level) اور **dependencies** (per-endpoint، parsed/typed values اور DI تک رسائی کے ساتھ — auth اور validation کے لیے بہتر) کے درمیان فرق جاننا صحیح ٹول منتخب کرنے کے لیے اہم ہے۔

CORS اور compression جیسی عام ضروریات built-in middleware کے ذریعے سنبھالی جاتی ہے، جبکہ custom middleware logging اور instrumentation کو cover کرتا ہے — اس معلومات کو عملی اور بار بار استعمال شدہ بناتا ہے well-structured، observable APIs بنانے کے لیے۔