Python3

🚀 آموزش فریمورک Pyramid - پارت 4: ایجاد REST API و ارتباط با دیتابیس

🎯 اهداف پارت 4:
- ایجاد یک REST API ساده در Pyramid
- استفاده از دیتابیس برای خواندن و نوشتن داده‌ها
- ارسال و دریافت داده‌ها به فرمت JSON

1️⃣ آشنایی با REST API
REST API یک سبک معماری برای طراحی سرویس‌های وب است که از متدهای HTTP برای انجام عملیات مختلف مانند GET، POST، PUT و DELETE استفاده می‌کند. در این بخش، یک API ساده برای مدیریت اطلاعات کاربر ایجاد می‌کنیم.

2️⃣ ایجاد API برای دریافت داده‌ها (GET)
برای شروع، یک View برای خواندن اطلاعات کاربران از دیتابیس ایجاد می‌کنیم. به فایل __init__.py بروید و کد زیر را اضافه کنید:

from pyramid.response import Response
from pyramid.view import view_config
from .models import Contact
import json

@view_config(route_name='api_users', renderer='json', request_method='GET')
def get_users(request):
    session = request.dbsession
    users = session.query(Contact).all()
    user_data = [{'id': user.id, 'name': user.name, 'email': user.email} for user in users]
    return user_data

🔍 توضیح کد:
- @view_config: این دکوراتور مشخص می‌کند که این View به درخواست‌های GET برای مسیر api_users پاسخ می‌دهد و داده‌ها را به فرمت JSON برمی‌گرداند.
- session.query(Contact).all(): تمام کاربران را از دیتابیس انتخاب می‌کند.
- user_data: داده‌ها به فرمت JSON آماده می‌شود.

3️⃣ تعریف مسیر API
برای اینکه API ما کار کند، باید یک مسیر جدید برای آن تعریف کنیم. به فایل __init__.py بروید و مسیر زیر را اضافه کنید:

def main(global_config, **settings):
    config = Configurator(settings=settings)
    config.add_route('api_users', '/api/users')
    config.scan()
    return config.make_wsgi_app()

🔍 توضیح کد:
- config.add_route('api_users', '/api/users'): مسیر api_users را به آدرس /api/users نگاشت می‌کند.

4️⃣ ایجاد API برای افزودن داده‌ها (POST)
حالا یک View جدید برای افزودن کاربران به دیتابیس با استفاده از درخواست POST ایجاد می‌کنیم. init__init__.py بروید و کد زیر را اضافه کنید:

@view_config(route_name='api_users', renderer='json', request_method='POST')
def add_user(request):
    session = request.dbsession
    try:
        data = request.json_body
        new_user = Contact(name=data['name'], email=data['email'])
        session.add(new_user)
        session.commit()
        return {'status': 'success', 'user_id': new_user.id}
    except Exception as e:
        session.rollback()
        return Response(json.dumps({'status': 'error', 'message': str(e)}), status=500, content_type='application/json')

🔍 توضیح کد:
- request.json_body: داده‌های ارسال شده به فرمت JSON را از درخواست استخراج می‌کند.
- new_user: یک شیء جدید از کلاس Contact ایجاد می‌کند و داده‌ها را در دیتابیس ذخیره می‌کند.
- session.commit(): تغییرات را در دیتابیس اعمال می‌کند.
- در صورت بروز خطا، عملیات برگردانده شده (rollback) و پیامی به فرمت JSON برمی‌گردد.

5️⃣ ایجاد API برای حذف داده‌ها (DELETE)
برای تکمیل API، یک View برای حذف کاربران از دیتابیس اضافه می‌کنیم. init__init__.py بروید و کد زیر را اضافه کنید:

@view_config(route_name='api_user', renderer='json', request_method='DELETE')
def delete_user(request):
    session = request.dbsession
    user_id = int(request.matchdict['id'])
    user = session.query(Contact).get(user_id)
    if user:
        session.delete(user)
        session.commit()
        return {'status': 'success'}
    return Response(json.dumps({'status': 'error', 'message': 'User not found'}), status=404, content_type='application/json')

🔍 توضیح کد:
- request.matchdict['id']: ID کاربر مورد نظر برای حذف را از URL استخراج می‌کند.
- session.delete(user): کاربر را از دیتابیس حذف می‌کند.
- در صورت یافت نشدن کاربر، پیام خطا به فرمت JSON بازگردانده می‌شود.

6️⃣ تعریف مسیر برای عملیات حذف
برای انجام عملیات حذف، به یک مسیر جدید نیاز داریم. init__init__.py بروید و مسیر زیر را اضافه کنید: