Tutorial membuat RESTful API menggunakan framework Flask [ Python ] #1 Persiapan
Kali ini, aku akan berbagi ilmu dari dunia backend. Ya berhubung sekarang juga sedang menggunakan hal yang sama dengan apa yang akan aku bagikan untuk mendukung pekerjaanku. Sangat tepat waktunya jika aku juga membagikannya sekarang agar kita bisa saling belajar dan berbagi sehingga makin banyak hal yang bisa kita pelajari bersama. 😁
Sebelumnya aku sudah menulis artikel tentang RESTful API yang menjelaskan apa itu RESTful API. Kalian bisa membacanya di SINI. Sebelum lebih dalam lagi untuk belajar bagaimana membuat RESTful API alangkah baiknya kalian memahaminya terlebih dahulu.
Pada tutorial ini, kita akan bersama-sama membuat RESTful API dengan menggunakan bahasa pemrograman Python. Untuk framework-nya kita akan menggunakan Flask. Sebelum mulai mengikuti tutorial ini. Seperti biasa, ada beberapa hal yang harus dipenuhi terlebih dahulu :
- 1. Pastikan kalian paham dulu tentang Apa itu RESTful API.
- 2. Pastikan kalian sudah menginstal Python di komputer kalian. (Download)
- 3. Pastikan kalian sudah menginstal Git. (Download)
1. Menyiapkan Project
Pertama, silahkan buka terminal / cmd yang ada pada komputermu lalu buat folder 'latihan' dengan menggunakan perintah ini :
mkdir latihan
Setelah itu, masuk ke folder yang sudah dibuat tersebut dengan perintah ini :
cd latihan
Setelah berada di folder latihan melalui terminal, kita akan mulai menginstal beberapa python module yang kita butuhkan untuk membuat project ini. Yang pertama kita akan menginstal Virtual Environtment (virtualenv). Eksekusi perintah ini di terminal :
pip install virtualenv
Setelah itu kita butuh satu module lagi untuk mempermudah kita membuat RESTful API dengan Flask yaitu Cookiecutter. Cookiecutter adalah tool yang akan membantu kita mempersiapkan project RESTful API beserta beberapa module lain yang diperlukan serta struktur folder yang sudah tertata dilengkapi dengan beberapa hal lain yang sangat mempermudah pekerjaan kita dalam membuat RESTful API. Langsung saja instal Cookiecutter dengan mengeksekusi perintah ini di terminal :
pip install --user cookiecutter
Sekarang, kita bisa mengambil Flask RESTful boilerplate dengan menggunakan cookiecutter. Masukan perintah ini di terminal :
cookiecutter https://github.com/karec/cookiecutter-flask-restful.git
Setelah mengeksekusi perintah di atas, kita akan diminta untuk memasukkan nama project (project_name). Disini kita sepakat untuk memberi nama project kita menjadi 'belajar_api'. Inputkan nama project tersebut dan tekan enter.
Setelah itu, kita akan diminta untuk menginputkan nama aplikasi. Disini kita juga sepakat memasukan nama aplikasi menjadi 'belajarapi'. Tekan enter, dan setelah itu akan muncul pertanyaan apakah kita mau menggunakan celery?. Pilih nomor 2 (Yes). Lalu tekan enter.
Untuk mengamankan Python dari hal yang tidak diinginkan, pastikan untuk menggunakan Virtual Environment. Eksekusi perintah di bawah ini untuk membuat virtual environment :
virtualenv venv
Setelah itu aktifkan virtual environment di terminal dengan mengeksekusi perintah ini :
source venv/bin/activate
Selanjutnya, buka file 'requirements.txt' yang ada di dalam folder project kita. Dan tambahkan 'SQLAlchemy-Utils' pada file tersebut. Setelah itu masukkan perintah ini untuk menginstal semua module yang dibutuhkan yang berada pada file requirements.txt :
pip install -r requirements.txt
2. Menjalankan Project di Local Environment
Yap, semua keperluan sudah disiapkan sekarang kita sudah bisa menjalankan project RESTful API kita. pertama, eksekusi perintah di bawah ini :
pip install -e .
Jangan lupakan titik kecil di akhir perintah. Setelah itu, jalankan project dengan perintah ini :
belajarapi run
Jika, kalian mengikuti langkah-langkahnya dari awal dengan benar. Pasti sekarang projectmu sudah bisa berjalan dengan baik 😏. Yak, selamat kamu sudah berhasil menyiapkan project dan menjalankannya dengan baik. Kamu siap untuk lanjut ke tutorial selanjutnya.
0 komentar:
Posting Komentar