Bagaimana Anda mengelola pengaturan dengan Pydantic?

Question

Accepted Answer

Aplikasi FastAPI mengelola konfigurasi dengan **`pydantic-settings`** (`BaseSettings`) — sebuah kelas yang membaca konfigurasi dari **variabel lingkungan** (dan file `.env`) dengan **validasi dan konversi tipe**, menjaga rahasia di luar kode dan memastikan konfigurasi benar saat startup.

## Mendefinisikan pengaturan

```python
from pydantic_settings import BaseSettings

class Settings(BaseSettings):
    app_name: str = "My API"
    database_url: str                       # required — must be provided
    secret_key: str                          # required (a secret)
    debug: bool = False
    max_connections: int = 10

class Config:
        env_file = ".env"                    # also read from a .env file

settings = Settings()                        # reads & VALIDATES env vars at startup
```

`BaseSettings` secara otomatis membaca setiap bidang dari **variabel lingkungan** yang sesuai (misalnya `DATABASE_URL`), mengonversi tipe (`"true"` → `bool`, `"10"` → `int`), dan **memvalidasi** — nilai yang diperlukan yang hilang atau tipe yang salah gagal segera saat startup dengan kesalahan yang jelas (fail-fast).

## Menggunakan pengaturan (melalui injeksi ketergantungan)

```python
from functools import lru_cache
from fastapi import Depends

@lru_cache                              # create the Settings once (cached)
def get_settings():
    return Settings()

@app.get("/info")
def info(settings: Settings = Depends(get_settings)):
    return {"app": settings.app_name, "debug": settings.debug}
```

Menyuntikkan pengaturan melalui ketergantungan yang di-cache membuatnya **dapat diuji** (ganti dalam pengujian) dan memastikan instance tunggal.

## File .env dan rahasia

```bash
# .env — local config, GITIGNORED (never commit secrets)
DATABASE_URL=postgresql://localhost/mydb
SECRET_KEY=dev-secret
DEBUG=true
```

```text
✓ Keep secrets in env vars / .env (gitignored); commit a .env.example documenting keys
✓ In production, inject config via the platform's environment / secret manager
✓ Validation at startup catches misconfiguration immediately (not deep in a request)
```

## Mengapa ini penting

Manajemen pengaturan yang tepat adalah **kebutuhan operasional** (aplikasi memerlukan konfigurasi yang berbeda di dev/staging/production) dan **persyaratan keamanan** (rahasia seperti URL database dan kunci tidak boleh pernah hardcoded dalam kontrol sumber — pelanggaran umum yang serius).

Pydantic `BaseSettings` menyediakan solusi FastAPI yang idiomatik, dan memahaminya adalah pengetahuan penting sehari-hari.

Keuntungan utamanya: membaca konfigurasi dari **variabel lingkungan** (menjaga rahasia di luar kode, pendekatan twelve-factor) dengan **konversi tipe dan validasi** otomatis — jadi konfigurasi yang salah gagal dengan cepat saat startup dengan kesalahan yang jelas daripada kegagalan runtime yang membingungkan.

Dikombinasikan dengan injeksi ketergantungan (membuat pengaturan dapat diuji dan singleton) dan praktik file `.env` yang diabaikan git untuk pengembangan lokal, ini memberi Anda konfigurasi yang aman, divalidasi, dan sesuai dengan lingkungan.

Mengetahui cara mendefinisikan pengaturan, menggunakannya melalui DI, dan mengelola rahasia dengan aman adalah fundamental untuk membangun aplikasi FastAPI yang siap produksi.