آموزش ساخت API با Flask در پایتون

در این بخش به بررسی نحوه ساخت API با Flask در پایتون می‌پردازیم، که یکی از فریمورک‌های سبک و محبوب برای توسعه وب است و به شما امکان می‌دهد با حداقل کدنویسی سرویس‌های وب سریع و کارآمد ایجاد کنید.

۱. نصب و راه‌اندازی Flask

برای شروع کار با Flask، ابتدا باید این فریمورک را نصب کنید و یک پروژه جدید راه‌اندازی کنید. در این آموزش ما در نظر میگیرم که شما این کار را قبلاً انجام داده اید.

۲. ایجاد یک اپلیکیشن ساده API با Flask

یک فایل جدید به نام app.py ایجاد کنید و کدهای زیر را در آن قرار دهید:

این کد، یک برنامه ساده Flask برای ایجاد یک API ساده است. در اینجا توضیحاتی در مورد هر قسمت از کد ارائه می‌دهم:

1. import و تعریف اشیاء:
   • from flask import Flask, jsonify: این خط کتابخانه Flask را وارد می‌کند و از آن برای ایجاد برنامه Flask استفاده می‌کند. همچنین jsonify برای تبدیل دیتا به فرمت JSON استفاده می‌شود.
   • app = Flask(__name__): این خط یک نمونه از کلاس Flask را ایجاد می‌کند که معمولاً به عنوان برنامه اصلی استفاده می‌شود.
2. تعریف مسیر (Route):
   • @app.route('/api', methods=['GET']): این خط یک مسیر برای ایندکس /api تعریف می‌کند که تنها درخواست‌های GET را قبول می‌کند.
3. تابع دسترسی به مسیر:
   • def get_data(): این تابع مربوط به مسیر /api است و هنگام درخواست GET فراخوانده می‌شود.
   • data = {'message': 'Welcome to my API!'}: اینجا یک دیکشنری ساده با یک پیام خوش‌آمدگویی ایجاد شده است.
   • return jsonify(data): این خط مقدار دیکشنری data را به فرمت JSON تبدیل و آن را به عنوان پاسخ ارسال می‌کند.
4. اجرای برنامه:
   • if __name__ == '__main__':: این بخش بررسی می‌کند که آیا این فایل به عنوان فایل اصلی اجرا شده است یا خیر.
   • app.run(debug=True): این خط کار سرور Flask را آغاز می‌کند. debug=True فعال‌سازی حالت اشکال‌زدایی را فراهم می‌کند که در هنگام توسعه برنامه بسیار مفید است.

با اجرای این برنامه، شما یک سرور Flask راه‌اندازی می‌کنید که یک API ساده با یک مسیر /api ایجاد کرده و پیام خوش‌آمدگویی را به صورت JSON ارسال می‌کند.

اجرای برنامه

حالا فایل app.py را اجرا کنید:

python app.py

با باز کردن مرورگر خود و مراجعه به آدرس http://127.0.0.1:5000/api، شما باید پیام خوش‌آمدگویی را دریافت کنید که از طریق API ارسال شده است.

این یک آموزش ساده برای ساخت یک API ابتدایی با استفاده از Flask در پایتون بود. شما می‌توانید این روند را گسترش دهید و مسیرها و مدل‌های داده بیشتری را ایجاد کنید تا API شما قابلیت‌های بیشتری داشته باشد.