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 मॉडेल्स, docstring्स) तयार होते, ते नेहमी वास्तविक अंमलबजावणीसह **सिंक्रोनाइজ** असते — हाताने लिहिलेल्या डॉक्सने त्रस्त दस्तावेजाच्या अप्रचलितेची दीर्घकालीन समस्या दूर करते.

इंटरेक्टिव्ह Swagger UI (`/docs`) डेव्हलपर्स आणि API ग्राहकांना एंडपॉइंट एक्सप्लोर आणि **ब्राउজरमध्ये थेट लाइव्ह टेस्ट** करण्याची परवानगी देते, डेव्हलपर अनुभव नाटकीयरीत्या सुधारते आणि समावेश घर्षण कमी करते.

जनरेट केलेले OpenAPI स्कीमा क्लायंट SDK जनरेशन आणि करार चाचणी देखील चालू करू शकते.

व्यावहारिक, अचूक, इंटरेक्टिव्ह API दस्तावेज मूलत: मुफ्तमध्ये मिळवणे — फक्त सुचिंतितपणे टाइप केलेली कोड लिहिल्याने — उत्पादकता आणि गुणवत्तेचा महत्वपूर्ण लाभ आहे, हे FastAPI चे महत्वाचे, वेगळे क्षमता बनवते.