Inisialisasi Project FastAPI di Windows 11

Bismillahirrohmaanirrohiim. Alhamdulillahi Robbil 'Alamiin. Allahumma Sholli 'Alaa Sayyidinaa Muhammad.

Sekitar 1 bulan ini, saya belajar membuat backend menggunakan FastAPI. FastAPI ini merupakan framework menggunakan bahasa pemrograman Python yang saya harap cepat, seperti namanya.

Ini merupakan rangkaian stack yang saat ini sedang saya pelajari, FARM (FastAPI, React.js, MongoDB) Stack. Anda bisa juga coba membaca buku yang saat ini sedang saya baca mengenai topik ini di sini.

Persiapan

Ada beberapa hal yang harus Anda siapkan agar bisa mengikuti tutorial ini.

• Perangkat dengan sistem operasi Windows 11. Bisa komputer, bisa laptop.
• Python yang sudah ter-install. Jika belum, install dulu.
• IDE. Saya menggunakan Visual Studio Code.
• Koneksi internet.

Jika sudah siap, mari kita langsung mulai saja.

Langkah-Langkah

Pertama, buat folder baru dengan nama coba di mana saja. Pada contoh kali ini, saya akan membuat folder tersebut di dalam Documents\LEARNING\FASTAPI.

Kemudian, tekan tombol Shift sembari klik kanan folder tersebut. Pilih Open in Terminal.

 

Jalankan perintah berikut untuk menginisialisasi virtual environment di dalam folder tersebut.

python -m venv venv

 

 

 

Selanjutnya, jalankan perintah berikut untuk membuka folder tersebut menggunakan Visual Studio Code.

code .

 

Jika berhasil, kita akan mendapatkan tampilan Visual Studio Code seperti berikut.

 

 

Setelah terbuka, aktifkan dulu virtual environment yang telah kira buat. Buka terminal dengan menekan tombol Ctrl+`.

 

 

Jalankan perintah berikut ini.

.\venv\Scripts\activate

 

 

Setelah virtual environment aktif (ditandai dengan ada (venv) di awal Terminal), jalankan perintah berikut untuk meng-install paket-paket yang kita perlukan untuk membuat project FastAPI.

pip install fastapi uvicorn

 

 

fastapi merupakan paket FastAPI. Sementara uvicorn merupakan paket web server untuk FastAPI yang akan kita gunakan.

 

Apabila proses instalasi selesai, kita akan mendapatkan tampilan seperti berikut.

 

 

Buat file utama untuk project kita dengan nama main.py pada direktori root project kita. Klik icon New File... di bagian atas panel Explorer Visual Studio Code.

 

 

Ketikkan main.py, kemudian tekan Enter.

 

Mari kita mulai dengan menginisialisasi aplikasi FastAPI kita di dalam file tersebut. Ketikkan kode berikut di dalam file main.py.

from fastapi import FastAPI

app = FastAPI()

Jika kita menjalankan aplikasi kita ini menggunakan uvicorn, seharusnya sudah bisa berjalan. Namun, masih belum ada satu path pun yang bisa diakses karena memang belum kita definisikan.

Mari kita buat satu route saja untuk memastikan project FastAPI kita bisa dijalankan.

Setelah baris kode app = FastAPI(), tambahkan potongan kode berikut di dalam main.py.

@app.get("/")

async def root():

  return {"message":"FastAPI is working!"}

 

 

Dekorator @app.get("/") kita gunakan untuk memberi tahu FastAPI bahwa function tepat di bawahnya ditujukan apabila user mengakses path root ("/") dengan method GET.

Sementara itu, kita me-return dictionary yang berisi konten  {"message":"FastAPI is working!"}. Konten ini secara otomatis akan dikonversi menjadi string dengan format JSON.

Mari kita jalankan project kita menggunakan uvicorn. Jalankan perintah berikut ini.

uvicorn main:app --reload

 

 

uvicorn merupakan server http yang sudah kita install dalam virtual environment kita. Kita bisa menjalankannya dengan mengetikkan uvicorn di dalam virtual environment yang sedang aktif.

 

main merupakan nama file python yang akan kita jalankan menggunakan uvicorn. Sementara app merupakan nama variabel berisi inisialisasi FastAPI. Ingat bahwa kita telah menginisialisasi variabel app berisi FastAPI() di dalam file main.py.

 

Parameter  --reload kita sertakan agar ketika kita melakukan perubahan pada kode, web akan secara otomatis di-refresh.

Sekarang, mari kita akses project kita. Kali ini, kita akan mengaksesnya langsung dari halaman dokumentasinya.

Buka browser, buka alamat berikut.

http://localhost:8000/docs

 

 

Ajaib sekali. Kita langsung mendapatkan versi Swagger dari API yang kita buat.

Kita bisa mencoba route yang telah kita buat tadi di dalam SwaggerUI dengan klik bagian berwarna biru (GET / Root), kemudian klik tombol Try It Out.

 

Klik tombol Execute untuk mencoba endpoint tersebut.

 

Scroll ke bawah, dan kita akan mendapatkan tampilan seperti ini jika semuanya berjalan dengan baik.

Selamat! Anda sudah berhasil membuat aplikasi FastAPI pertama Anda!

Penutup

Saat ini, seharusnya kita sudah tahu cara menginisialisasi project FastAPI di Windows 11. Kita bisa mulai meng-eksplor fitur-fitur yang ada di dalamnya. Kita bisa mempelajarinya langsung di situs resminya. Apabila ada sesuatu yang ingin Anda tanyakan perihal FastAPI, silakan tinggalkan komentar atau ketuk DM saya di LinkedIn saya!

Semoga bermanfaat.

Wallahul muwaafiq ilaa aqwaamith thooriq.

Referensi

1. https://docs.python.org/3/library/venv.html 
2. https://fastapi.tiangolo.com/