Bagaimanakah anda mentakrifkan laluan (operasi laluan)?

Question

Accepted Answer

Dalam FastAPI, **operasi laluan** adalah laluan — fungsi yang dihiasi dengan penghiasan kaedah HTTP (`@app.get`, `@app.post`, dll) yang mengendalikan permintaan ke laluan. Nilai pulangan fungsi secara automatik disusun dalam JSON.

## Mentakrifkan laluan untuk setiap kaedah HTTP

```python
from fastapi import FastAPI
app = FastAPI()

@app.get("/items")                # GET /items
def list_items():
    return [{"id": 1}, {"id": 2}]  # dict/list → automatically JSON-serialized

@app.get("/items/{item_id}")      # GET /items/5 — path parameter
def get_item(item_id: int):        # type hint converts "5" → int (and validates)
    return {"id": item_id}

@app.post("/items")               # POST /items
def create_item(item: Item):
    return item

@app.put("/items/{item_id}")      # PUT, PATCH, DELETE work the same way
@app.delete("/items/{item_id}")
def delete_item(item_id: int):
    return {"deleted": item_id}
```

Setiap penghiasan memetakan kaedah HTTP + laluan kepada pengendali. Nama fungsi adalah milik anda; penghiasan mentakrifkan laluan. Dict/senarai/model Pydantic yang dikembalikan secara automatik disusun dalam JSON — tiada `json.dumps` manual.

## Susunan penting untuk laluan yang bertindih

```python
@app.get("/users/me")            # ✅ specific route FIRST
def read_me(): ...
@app.get("/users/{user_id}")     # dynamic AFTER — else "me" matches {user_id}
def read_user(user_id: int): ...
```

FastAPI memadankan laluan dalam susunan pengisytiharan, jadi letakkan laluan statik sebelum yang dinamik.

## Metadata operasi (mendorong dok)

```python
@app.get("/items", tags=["items"], summary="List items", status_code=200)
def list_items(): ...
```

Parameter penghiasan (`tags`, `summary`, `status_code`, `response_model`) mengkonfigurasi kelakuan dan memperkaya dokumentasi yang dijana secara automatik.

## Mengapa ia penting

Operasi laluan adalah asas setiap aplikasi FastAPI — mereka mentakrifkan titik akhir API anda dan bagaimana permintaan ditangani.

Memahami corak penghiasan-per-kaedah-HTTP, bahawa nilai pulangan secara automatik disusun dalam JSON (tanpa boilerplate), bahawa petunjuk jenis pada parameter mendorong penukaran dan pengesahan, dan bahawa susunan laluan penting untuk laluan yang bertindih ialah pengetahuan penting sehari-hari untuk membina mana-mana titik akhir.

Metadata penghiasan juga memberi makan dokumentasi automatik FastAPI, menghubungkan laluan terus ke dok.

Ini adalah perkara pertama dan paling asas untuk dikuasai dalam FastAPI.