FastAPI स्वचालित रूप से दस्तावेज कैसे उत्पन्न करता है?

Question

Accepted Answer

FastAPI **आपके कोड से स्वचालित रूप से इंटरेक्टिव API दस्तावेज़ उत्पन्न करता है** — आपके रूट्स, पैरामीटर और Pydantic मॉडल को OpenAPI स्कीमा में बदल दिया जाता है, जो शून्य अतिरिक्त प्रयास के साथ दो ब्राउज़ करने योग्य डॉक UI (Swagger UI और ReDoc) को शक्ति देता है।

## आपको मुफ्त में डॉक्स मिलते हैं

```python
class Item(BaseModel):
    name: str
    price: float = Field(gt=0, description="Price in USD")

@app.post("/items", tags=["items"], summary="Create an item")
def create_item(item: Item):
    """Create a new item with a name and price."""   # docstring → endpoint description
    return item
```

बस टाइप किए गए एंडपॉइंट्स और मॉडल लिखने से, FastAPI पूर्ण डॉक्स तैयार करता है — कोई अलग दस्तावेज़ फ़ाइल लिखने या बनाए रखने की आवश्यकता नहीं है।

## दो अंतर्निहित डॉक UI

```text
/docs   → Swagger UI — interactive: browse endpoints AND test them in the browser
          (fill in parameters, send requests, see responses live)
/redoc  → ReDoc — a clean, readable reference-style view
/openapi.json → the raw OpenAPI schema (usable to generate client SDKs, etc.)
```

`/docs` पर जाएं और आप हर एंडपॉइंट की खोज कर सकते हैं, आवश्यक पैरामीटर और प्रतिक्रिया आकार देख सकते हैं, और **ब्राउज़र से सीधे वास्तविक अनुरोध भेज सकते हैं** — विकास के दौरान और API उपभोक्ताओं के लिए अमूल्य।

## डॉक्स सामग्री कहाँ से आती है

```text
Route decorators → paths, HTTP methods, tags, summaries
Type hints       → parameter types, required/optional
Pydantic models  → request/response schemas, field constraints & descriptions
Docstrings       → endpoint descriptions
Field(..., description=, example=) → field-level docs and examples
```

सब कुछ आपके द्वारा पहले से लिखे गए कोड से प्राप्त होता है — डॉक्स स्वचालित रूप से **कार्यान्वयन के साथ सिंक में** रहते हैं।

## डॉक्स को समृद्ध करना

```python
app = FastAPI(title="My API", version="1.0", description="...")
@app.get("/x", response_model=Item, responses={404: {"description": "Not found"}})
```

## यह क्यों महत्वपूर्ण है

स्वचालित इंटरेक्टिव दस्तावेज़ FastAPI की सबसे प्रशंसित सुविधाओं में से एक है और इसकी लोकप्रियता का मुख्य कारण है।

क्योंकि दस्तावेज़ आपके कोड (रूट्स, टाइप हिंट्स, Pydantic मॉडल, docstrings) से सीधे उत्पन्न होते हैं, वे हमेशा **वास्तविक कार्यान्वयन के साथ सिंक में** रहते हैं — दस्तावेज़ के पुरानी पड़ने की पुरानी समस्या को खत्म करते हैं, जो हाथ से लिखे गए डॉक्स को प्रभावित करती है।

इंटरेक्टिव Swagger UI (`/docs`) डेवलपर्स और API उपभोक्ताओं को ब्राउज़र में सीधे **एंडपॉइंट्स खोजने और परीक्षण करने** देता है, जिससे डेवलपर अनुभव में नाटकीय रूप से सुधार होता है और एकीकरण घर्षण कम होता है।

उत्पन्न OpenAPI स्कीमा क्लाइंट SDK जनरेशन और अनुबंध परीक्षण को भी चलाता सकता है।

पेशेवर, सटीक, इंटरेक्टिव API डॉक्स अनिवार्य रूप से मुफ्त में प्राप्त करना — केवल अच्छी तरह से टाइप किए गए कोड लिखकर — एक महत्वपूर्ण उत्पादकता और गुणवत्ता लाभ है, जो इसे FastAPI की एक महत्वपूर्ण, विशिष्ट क्षमता बनाता है।