FastAPI ले स्वचालित दस्तावेज कसरी उत्पन्न गर्छ?

Question

Accepted Answer

FastAPI **आपके कोड से स्वचालित रूप से इंटरैक्टिव API दस्तावेज उत्पन्न करता है** — आपके routes, parameters, र Pydantic models एक OpenAPI schema मा परिणत हुन्छन्, जो दुई browsable doc UIs (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
```

केवल typed endpoints र models लेखेर, FastAPI पूर्ण दस्तावेज उत्पन्न गर्छ — कुनै अलग दस्तावेज फाइल लेख्न वा अनुरक्षण गर्न आवश्यक छैन।

## दुई अन्तर्निर्मित doc UIs

```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` भ्रमण गर्नुहोस् र तपाईं हरेक endpoint अन्वेषण गर्न सक्नुहुन्छ, आवश्यक parameters र response shapes हेर्न सक्नुहुन्छ, र ब्राउजरबाट सीधै **वास्तविक requests भेज्न** सक्नुहुन्छ — विकास र API उपभोक्ताहरूको लागि अमूल्य।

## doc content कहाँ आएको हो

```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 को सबैभन्दा प्रशंसित सुविधाहरू मध्ये एक हो र यसको लोकप्रियताको मुख्य कारण हो।

कारण दस्तावेजहरू आपके कोडबाट सीधे उत्पन्न हुन्छन् (routes, type hints, Pydantic models, docstrings), तिनीहरू सधैं वास्तविक कार्यान्वयनसँग **सिंक मा** हुन्छन् — हस्तलिखित दस्तावेजहरूलाई सताउने दस्तावेजहरू पुरानो हुने पुरानो समस्या समाप्त गर्दै।

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

उत्पन्न OpenAPI schema ले client SDK generation र contract testing लाई पनि चलाउन सक्छ।

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