Beranda / Coding / Tutorial Blog

Cara Membuat API Sederhana dengan Flask

Posting Komentar

 

API (Application Programming Interface) adalah antarmuka yang memungkinkan aplikasi untuk berkomunikasi dengan aplikasi lain. Salah satu framework yang sering digunakan untuk membuat API adalah Flask. Flask adalah framework web ringan untuk Python yang memungkinkan Anda membuat aplikasi web dan API dengan cepat. Dalam artikel ini, kita akan membahas cara membuat API sederhana dengan Flask, termasuk implementasi aplikasi CRUD (Create, Read, Update, Delete) yang umum digunakan dalam pengelolaan data.


Persiapan Awal

Sebelum mulai membuat API, pastikan Anda telah menginstal Python di sistem Anda. Flask dapat diinstal menggunakan pip, pengelola paket Python. Jika Flask belum terinstal, jalankan perintah berikut di terminal atau command prompt untuk menginstalnya:

Setelah Flask terinstal, Anda dapat mulai membuat aplikasi API sederhana dengan membuat file Python baru, misalnya app.py.


Membuat Aplikasi Flask

Langkah pertama adalah mengimpor Flask dan membuat instance aplikasi. Berikut adalah kode dasar untuk memulai aplikasi Flask:


from flask import Flask, jsonify, request

app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello, World!'

if __name__ == '__main__':
    app.run(debug=True)

Pada kode di atas, kita membuat instance aplikasi Flask dengan Flask(__name__). Kemudian, kita mendefinisikan route (@app.route('/')) yang akan mengarah pada fungsi hello_world(). Ketika Anda menjalankan aplikasi ini, Flask akan menyajikan halaman yang menampilkan pesan "Hello, World!" ketika Anda mengakses root URL.


Membuat API CRUD Sederhana

Untuk membuat API yang lebih berguna, kita akan menambahkan fungsionalitas CRUD. API CRUD memungkinkan pengguna untuk membuat, membaca, memperbarui, dan menghapus data. Kita akan menggunakan data sederhana berupa daftar item, di mana setiap item memiliki ID dan nama.

Berikut adalah contoh implementasi aplikasi CRUD menggunakan Flask:


from flask import Flask, jsonify, request

app = Flask(__name__)

# Data dummy untuk contoh
items = [
    {'id': 1, 'name': 'Item 1'},
    {'id': 2, 'name': 'Item 2'}
]

# Read: Mendapatkan semua item
@app.route('/items', methods=['GET'])
def get_items():
    return jsonify(items)

# Read: Mendapatkan item berdasarkan ID
@app.route('/items/', methods=['GET'])
def get_item(item_id):
    item = next((item for item in items if item['id'] == item_id), None)
    if item is None:
        return jsonify({'message': 'Item not found'}), 404
    return jsonify(item)

# Create: Menambahkan item baru
@app.route('/items', methods=['POST'])
def create_item():
    new_item = request.get_json()
    items.append(new_item)
    return jsonify(new_item), 201

# Update: Memperbarui item berdasarkan ID
@app.route('/items/', methods=['PUT'])
def update_item(item_id):
    item = next((item for item in items if item['id'] == item_id), None)
    if item is None:
        return jsonify({'message': 'Item not found'}), 404

    data = request.get_json()
    item['name'] = data.get('name', item['name'])
    return jsonify(item)

# Delete: Menghapus item berdasarkan ID
@app.route('/items/', methods=['DELETE'])
def delete_item(item_id):
    global items
    items = [item for item in items if item['id'] != item_id]
    return jsonify({'message': 'Item deleted'}), 200

if __name__ == '__main__':
    app.run(debug=True)

Penjelasan Kode API CRUD

  1. Route GET /items
    Route ini akan mengembalikan seluruh data item dalam bentuk JSON. Ketika Anda mengakses URL ini, API akan merespons dengan daftar semua item.

  2. Route GET /items/<int:item_id>
    Route ini akan mengembalikan data item berdasarkan ID. Jika item dengan ID tersebut tidak ditemukan, API akan mengembalikan pesan kesalahan dengan status code 404.

  3. Route POST /items
    Route ini memungkinkan pengguna untuk menambahkan item baru ke daftar. Data item baru diterima dalam format JSON dan ditambahkan ke daftar item.

  4. Route PUT /items/<int:item_id>
    Route ini memungkinkan pengguna untuk memperbarui nama item berdasarkan ID. Jika item tidak ditemukan, API akan mengembalikan pesan kesalahan.

  5. Route DELETE /items/<int:item_id>
    Route ini memungkinkan pengguna untuk menghapus item berdasarkan ID. Setelah item dihapus, API akan mengembalikan pesan konfirmasi.


Menguji API

Untuk menguji API, Anda bisa menggunakan alat seperti Postman atau cURL. Berikut adalah contoh bagaimana cara menguji API dengan menggunakan cURL:

  • GET all items:

    arduino
    curl http://127.0.0.1:5000/items

  • GET item by ID:

    arduino
    curl http://127.0.0.1:5000/items/1

  • POST create item:

    graphql
    curl -X POST http://127.0.0.1:5000/items -H "Content-Type: application/json" -d '{"id": 3, "name": "Item 3"}'

  • PUT update item:

    ruby
    curl -X PUT http://127.0.0.1:5000/items/3 -H "Content-Type: application/json" -d '{"name": "Updated Item 3"}'

  • DELETE item:

    arduino
    curl -X DELETE http://127.0.0.1:5000/items/3


Membuat API sederhana dengan Flask sangat mudah dan cepat. Dengan menggunakan Flask, Anda bisa membangun aplikasi API untuk keperluan proyek Anda tanpa perlu kerumitan framework yang lebih besar. Melalui panduan ini, Anda telah mempelajari cara membuat API yang dapat menangani operasi CRUD dasar, yang merupakan bagian penting dalam pengelolaan data pada aplikasi berbasis web. Dengan langkah-langkah sederhana ini, Anda bisa mulai membangun API untuk aplikasi lebih kompleks di masa depan.

Posting Komentar untuk "Cara Membuat API Sederhana dengan Flask"