Dokumentasi Otomatis: Swagger & ReDoc
Penjelasan
Salah satu fitur paling terkenal FastAPI: setiap endpoint otomatis terdokumentasi di /docs (Swagger UI, interaktif — bisa langsung dicoba) dan /redoc (ReDoc, tampilan lebih rapi untuk dibaca). Dokumentasi ini di-generate dari type hints, model Pydantic, dan docstring fungsi — tanpa kamu menulis dokumentasi terpisah.
Contoh Konsep
app = FastAPI(
title='Catatan API',
description='API sederhana untuk mengelola catatan',
version='1.0.0',
)
@app.get('/catatan', summary='Ambil semua catatan', tags=['catatan'])
def list_catatan():
"""Mengembalikan seluruh catatan yang tersimpan."""
return []Praktikum
Tambahkan title, description, dan version ke instance FastAPI() utama, lalu tambahkan summary ke satu endpoint.
Ketik/edit bebas di sini untuk latihan — kode ini tidak dijalankan.
Tips
Dokumentasi otomatis inilah yang membuat FastAPI populer untuk tim yang butuh API kontrak jelas ke frontend — frontend bisa eksplorasi dan test API langsung dari /docs tanpa perlu Postman.