Bagaimana Anda mendefinisikan rute (path operations)?

Question

Accepted Answer

Dalam FastAPI, sebuah **path operation** adalah rute — fungsi yang didekorasi dengan dekorator metode HTTP (`@app.get`, `@app.post`, dll.) yang menangani permintaan ke jalur. Nilai pengembalian fungsi secara otomatis diserialisasi ke JSON.

## Mendefinisikan rute untuk setiap metode 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 dekorator memetakan metode HTTP + jalur ke pengendali. Nama fungsi adalah milik Anda; dekorator mendefinisikan rute. Dict/daftar/model Pydantic yang dikembalikan secara otomatis diserialisasi ke JSON — tidak ada `json.dumps` manual.

## Urutan penting untuk jalur yang tumpang tindih

```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 mencocokkan rute dalam urutan deklarasi, jadi letakkan jalur statis sebelum jalur dinamis.

## Metadata operasi (mendorong dokumentasi)

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

Parameter dekorator (`tags`, `summary`, `status_code`, `response_model`) mengkonfigurasi perilaku dan memperkaya dokumentasi yang dihasilkan secara otomatis.

## Mengapa ini penting

Path operations adalah fondasi setiap aplikasi FastAPI — mereka mendefinisikan endpoint API Anda dan bagaimana permintaan ditangani.

Memahami pola dekorator-per-metode-HTTP, bahwa nilai pengembalian secara otomatis diserialisasi ke JSON (tanpa boilerplate), bahwa jenis hint pada parameter mendorong konversi dan validasi, dan urutan rute penting untuk jalur yang tumpang tindih adalah pengetahuan esensial sehari-hari untuk membangun endpoint apa pun.

Metadata dekorator juga memberi makan dokumentasi otomatis FastAPI, menghubungkan rute langsung ke dokumentasi.

Ini adalah hal pertama dan paling fundamental untuk dikuasai di FastAPI.