ਫ਼ਾਸਟਏਪੀਆਈ ਆਪਣੇ ਆਪ ਡੌਕੂਮੰਟੇਸ਼ਨ ਕਿਵੇਂ ਬਣਾਉਂਦਾ ਹੈ?

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 ਪੂਰੀ ਡੌਕੂਮੰਟੇਸ਼ਨ ਬਣਾਉਂਦਾ ਹੈ — ਕੋਈ ਵੱਖਰੀ documentation file ਲਿਖਣੀ ਜਾਂ ਰੱਖ-ਸੰਭਾਲ ਕਰਨੀ ਨਹੀਂ ਪਏ।

## ਦੋ built-in 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 ਨੂੰ explore ਕਰ ਸਕੋ, ਲੋੜੀਂਦੇ parameters ਅਤੇ response shapes ਦੇਖ ਸਕੋ, ਅਤੇ **browser ਤੋਂ ਸਿੱਧਾ real requests** ਭੇਜ ਸਕੋ — development ਅਤੇ API consumers ਲਈ ਬਹੁਤ ਜਰੂਰੀ।

## 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
```

ਸਭ ਕੁਝ ਉਸ ਕੋਡ ਤੋਂ ਆਉਂਦਾ ਹੈ ਜੋ ਤੁਸੀਂ ਪਹਿਲਾਂ ਹੀ ਲਿਖਿਆ ਹੋਇਆ ਹੈ — ਡੌਕੂਮੰਟੇਸ਼ਨ implementation ਨਾਲ ਆਪਣੇ ਆਪ **ਸਿੰਕ ਵਿੱਚ ਰਹਿੰਦੀ ਹੈ**।

## Docs ਨੂੰ ਬਿਹਤਰ ਬਣਾਉਣਾ

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

## ਇਹ ਕਿਉਂ ਮਾਇਨੇ ਰੱਖਦਾ ਹੈ

Automatic interactive documentation FastAPI ਦੀਆਂ ਸਭ ਤੋਂ ਪ੍ਰਸਿੱਧ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਵਿੱਚ ਇੱਕ ਹੈ ਅਤੇ ਇਸਦੀ ਸ਼ਹਿਰਤ ਦਾ ਇੱਕ ਮੁੱਖ ਕਾਰਨ ਹੈ।

je੍ਯੋਂ ਕਿ ਡੌਕੂਮੰਟੇਸ਼ਨ ਸਿੱਧੀ ਆਪਣੇ ਕੋਡ (routes, type hints, Pydantic models, docstrings) ਤੋਂ ਬਣੀ ਹੁੰਦੀ ਹੈ, ਇਹ ਹਮੇਸ਼ਾ ਅਸਲ implementation ਨਾਲ **ਸਿੰਕ ਵਿੱਚ ਰਹਿੰਦੀ ਹੈ** — ਉਹ ਰੁਕਾਵਟ ਖ਼ਤਮ ਕਰਦੀ ਹੈ ਜੋ hand-written docs ਨੂੰ ਅਸਲੇ ਬੋਝ ਭਾਵਤੀ ਹੈ।

Interactive Swagger UI (`/docs`) ਡਿਵੈਲਪਰਾਂ ਅਤੇ API consumers ਨੂੰ browser ਵਿੱਚ endpoints ਨੂੰ explore ਅਤੇ **test ਕਰਨ** ਦਿੰਦਾ ਹੈ, ਜੋ developer experience ਵਿੱਚ ਬਹੁਤ ਸੁਧਾਰ ਲਿਆਉਂਦਾ ਹੈ ਅਤੇ integration friction ਘਟਾਉਂਦਾ ਹੈ।

ਜਨਰੇਟ ਕੀਤਾ OpenAPI schema client SDK generation ਅਤੇ contract testing ਨੂੰ ਵੀ ਚਲਾ ਸਕਦਾ ਹੈ।

ਪ੍ਰੋਫੈਸ਼ਨਲ, accurate, interactive API docs ਪ੍ਰਾਪਤ ਕਰਨਾ ਲਗਭਗ ਮੁਫ਼ਤ ਵਿੱਚ — ਸਿਰਫ਼ well-typed code ਲਿਖ ਕੇ — ਇੱਕ ਮਹੱਤਵਪੂਰਨ productivity ਅਤੇ quality win ਹੈ, ਜੋ ਇਸ ਨੂੰ ਇੱਕ ਮਹੱਤਵਪੂਰਨ, distinctive FastAPI capability ਬਣਾਉਂਦਾ ਹੈ।