برای ساخت یک API ساده با Flask (فریم‌ورک سبک Python برای توسعه وب و سرویس‌های REST)، تنها به چند خط کد نیاز دارید. در ادامه، به‌صورت رسمی و گام‌به‌گام، نحوه‌ی ساخت یک API ساده را توضیح می‌دهم:
۱. پیش‌نیازها
undefined
pip install Flask
۲. ساخت فایل اصلی پروژه
فایل جدیدی به نام app.py بسازید و کد زیر را در آن بنویسید:
undefined
from flask import Flask, jsonify, request
app = Flask(__name__)
# دیتای فرضی برای تست
users = [
{'id': 1, 'name': 'Ali'},
{'id': 2, 'name': 'Sara'}
]
# روت اصلی
@app.route('/')
def index():
return "Welcome to the Flask API!"
# API برای گرفتن لیست کاربران
@app.route('/api/users', methods=['GET'])
def get_users():
return jsonify(users)
# API برای افزودن کاربر جدید
@app.route('/api/users', methods=['POST'])
def add_user():
data = request.get_json()
new_user = {
'id': len(users) + 1,
'name': data.get('name', 'Unknown')
}
users.append(new_user)
return jsonify(new_user), 201
if __name__ == '__main__':
app.run(debug=True)
۳. اجرای پروژه
در ترمینال، وارد پوشه پروژه شده و دستور زیر را بزنید:
undefined
python app.py
API روی آدرس زیر اجرا می‌شود:
undefined
http://127.0.0.1:5000/
۴. تست API با ابزارهای مختلف
برای تست endpointها از ابزارهایی مثل Postman یا curl استفاده کنید:
undefined
curl -X POST http://localhost:5000/api/users -H "Content-Type: application/json" -d '{"name": "Reza"}'
نکات پیشرفته پیشنهادی
-
اضافه کردن سیستم احراز هویت (مثلاً با JWT)
-
اتصال به دیتابیس (مثلاً SQLite یا PostgreSQL)
-
استفاده از Flask-RESTful برای ساختار بهتر
-
مدیریت خطاها با استفاده از error handlers
