RESTful API Sederhana Menggunakan Flask
Kali ini saya akan mencoba menuliskan cara pembuatan RESTful API menggunakan Flask.
RESTful API merupakan implementasi dari API (Application Programming Interface), yang mana adalah suatu arsitektur metode komunikasi menggunakan protokol HTTP untuk pertukaran data (REST, Representional State Transfer).
Flask sendiri adalah sebuah microframework yang dapat digunakan dalam pembuatan web dengan bahasa pemrograman Python.
Apabila Python belum terpasang, maka download Python lalu install di komputer.
Buat virtual environment di komputer dengan membuka shell (command prompt) terlebih dahulu.
$ python -m venv env
Aktifkan environment tersebut:
- Windows:
$ env\Scripts\activate
- Unix:
$ . env/bin/activate
Selanjutnya install Flask menggunakan PIP (komputer harus terhubung internet).
(env) $ pip install flask
SQLite kali ini digunakan untuk CRUD data (Create/POST, Read/GET, Update/PUT, dan DELETE) di database.
Akan dibuat RESTful API user dengan HTTP Verbs sebagai berikut:
- GET
GET /users : Mengembalikan daftar user
GET /users/1234 : Mengembalikan data user dengan ID 1234 - POST
POST /users : Membuat data user baru
- PUT
PUT /users/1234 : Mengupdate data user dengan ID 1234
- DELETE
DELETE /users/1234 : Menghapus data user dengan ID 1234
Berikut ini adalah source code dari aplikasi.
Jalankan aplikasi dengan cara berikut ini.
(env) $ python restful_api_with_flask.py
Apabila aplikasi berjalan tanpa gangguan, maka akan tampil output seperti ini:
(env) $ python restful_api_with_flask.py
* Serving Flask app "restful_api_with_flask" (lazy loading)
* Environment: production
WARNING: Do not use the development server in a production environment.
Use a production WSGI server instead.
* Debug mode: on
* Restarting with stat
* Debugger is active!
* Debugger PIN: 120-914-758
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
Lalu lakukan API request method GET, POST, PUT, atau DELETE (pada contoh ini URL adalah http://127.0.0.1:5000/users) menggunakan Postman untuk memastikan RESTful API telah berhasil dijalankan.
Tekan CTRL + C untuk mengakhiri jalannya aplikasi. Sehingga shell kembali menjadi seperti ini.
(env) $
Kita dapat keluar dari environment dengan menggunakan instruksi sebagai berikut:
(env) $ deactivate
Demikian implementasi RESTful API menggunakan Flask, semoga bermanfaat dan dapat memberikan pemahaman umum terkait topik ini.