Nawa FastAPI ke samar takardarjiya jimloli a guje-guje?

Question

Accepted Answer

FastAPI **yana samar da takardarjiya jimloli interactive na API a guje-guje daga kodunka** — tunanininka, ma'auni, da yawancin Pydantic ana canza su zuwa OpenAPI schema, wanda ya ba da iko ga cibiyoyi biyu na gida na takardar jiya (Swagger UI da ReDoc) ba tare da aiki waje ba.

## Kana karbi takardar jiya kyauta

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

Sai da kayi rubutu na iya fadowa da tsari da yawancin, FastAPI yana samar cikakken takardar jiya — babu waje waje na takardar jiya da za ka rubutu ko ardita.

## Cibiyoyi biyu na takardar jiya na gida

```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.)
```

Ziyarci `/docs` kuma zaka iya diddigin kowane endpoint, ga ma'aunin da aka bukata da siffar amsa, kuma **direwa ainihin bukatai** kakasar jiya — mahimmanci a lokacin haɓaka da ga masu amfani da API.

## Inda abuhuwan takardar jiya ke tsohuwa

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

Komai yake fitowa daga kodun da ka rubuta a nan jiya — takardar jiya tana ci gaba a guje-guje **hamdiya** tare da aiwatarwa.

## Sauvan takardar jiya

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

## Me yasa ya matuwa

Auto interactive takardar jiya shine yana gida gida a cikin salo mafi girma FastAPI da babbar dalili na yana oniwu.

Saboda takardar jiya ta samar a guje-guje daga kodunka (wajen, ishi ishi, yawancin Pydantic, takardar jiya), suna kasance koyaushe **hamdiya** tare da aiwatar gaske — kawar da babbar matsala na takardar jiya tana tashi, wanda suke bugi takardar jiya a hannu.

Sabsabar interactive Swagger UI (`/docs`) yana ba wa masu buƙata da masu amfani da API damar diddigin kuma **gwada ƙansuwar a kai jiya** kai tsaye, wanda ya bada sosai buhalatacciyar ƙwararren dukkan hali da daidaita gaba ɗaya.

Samar da OpenAPI schema na iya aida da samar da SDK na kasuwa da gwada hankali kuma.

Gani ga takardar jiya na gida, gama, jimloli interactive API diddinge kyauta — ta haka a rubuta kodun mafi kyau — babbar nasara ne ta iska da tattalin arzikinsa, wanda yake sa haka babbar fasaha ta FastAPI na waje.