rest یکی از مباحث کلیدی در توسعه وب مدرن است که با کارآیی بالا و طراحی ساده برای ساخت API های قابل مقیاس بسیار مناسب است. در این مقاله سعی دارم گام به گام نحوه ساخت یک REST API با فریمورک FastAPI را به زبان ساده توضیح دهم تا بتوانید به سرعت پروژه‌های کاربردی خود را آغاز کنید و به استانداردها و بهترین شیوه‌ها پایبند باشید.

– چرا از FastAPI استفاده کنیم؟
FastAPI در مقایسه با فریمورک‌های سنتی Python مانند Django یا Flask، با ارائه مدل‌های بیشترین کارایی، پشتیبانی قوی از Type hints و اعتبارسنجی داده‌ها با کتابخانه Pydantic، و مستندسازی خودکار با Swagger UI و ReDoc گزینه‌ای عالی برای توسعه APIهای REST است. رندر سریع‌تر، بهره‌وری بالاتر تیم‌ها و تجربه کاربری بهتر از جمله مزایای این فریمورک است.

H2: گام‌های پایه برای ایجاد REST API با FastAPI

– نصب و راه‌اندازی اولیه
برای شروع، یک محیط مجازی ایجاد کنید و پکیج fastapi و uvicorn را نصب نمایید. دستورالعمل معمول به شکل زیر است:
pip install fastapi uvicorn
سپس با استفاده از یک فایل Python نمونه، API خود را تعریف کنید. با اجرای زیر می‌توانید سرور را راه‌اندازی کنید:
uvicorn main:app –reload
در اینجا main.py حاوی یک شیء app از کلاس FastAPI است.

– تعریف مسیرهای API (Endpoints)
در FastAPI، هر مسیر با تابعی که با دکوریتورهایی مانند @app.get، @app.post، @app.put، یا @app.delete مشخص می‌شود، تعریف می‌شود. برای یک API ساده که اطلاعات کاربری را مدیریت می‌کند، می‌توانید به این صورت عمل کنید:
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
id: int
name: str
email: str

fake_db = []

@app.post(“/users/”)
def create_user(user: User):
fake_db.append(user)
return user

این نمونه نشان می‌دهد که اعتبارسنجی داده‌ها با Pydantic انجام می‌شود و ورودی کاربر به شکل مدل User اعتبار می‌گردد.

H2: اعتبارسنجی و مدل‌های داده با Pydantic

– استفاده از Pydantic برای اعتبارسنجی
Pydantic به شما امکان می‌دهد ورودی‌ها را به مدل‌های مشخص خلاصه کنید و FastAPI به طور خودکار داده‌ها را از درخواست‌ها استخراج و اعتبارسنجی می‌کند. این باعث کاهش خطاهای ناشی از داده‌های ورودی غیر معتبر می‌شود و امنیت API را ارتقا می‌دهد.

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

H2: مدیریت پایگاه داده و ارتباط با REST API

– استفاده از ORM و گفتگو با دیتابیس
برای پروژه‌های واقعی، اتصال به دیتابیس مهم است. SQLAlchemy یا Tortoise ORM گزینه‌های محبوبی هستند که با FastAPI به خوبی کار می‌کنند. به‌طور نمونه، می‌توانید از SQLAlchemy برای مدل‌سازی جداول و از AsyncSession برای دسترسی غیرهمزمان استفاده کنید تا عملکرد API بهبود یابد.

– نمونه ساده با SQLAlchemy
برای یک پروژه ساده از یک مدل User استفاده کنید:
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

class UserModel(Base):
__tablename__ = “users”
id = Column(Integer, primary_key=True, index=True)
name = Column(String, index=True)
email = Column(String, unique=True, index=True)

سپس در FastAPI، با ایجاد SessionManager و استفاده از async_session به عملیات CRUD دست پیدا خواهید کرد.

H3: مدیریت عملیات CRUD با RESTful Routes

– Create: POST /users/
– Read: GET /users/ و GET /users/{id}
– Update: PUT /users/{id}
– Delete: DELETE /users/{id}

با استفاده از استانداردهای RESTful، کاربران API شما با مسیرهای آشنا و قابل پیش‌بینی کار خواهند کرد. پیاده‌سازی این مسیرها با FastAPI به‌سادگی امکان‌پذیر است و با استفاده از مدل‌های پانتیک یا شناسه‌های منطقی، کنترل دسترسی و اعتبارسنجی را هم لحاظ می‌کنید.

H2: امنیت و احراز هویت در REST API با FastAPI

– احراز هویت ساده با OAuth2 و JWT
برای محافظت از مسیرهای حساس، می‌توانید از OAuth2 با رمزدایی (password flow) و توکن JWT استفاده کنید. FastAPI به طور کامل از این معماری پشتیبانی می‌کند و با استفاده از dependency injection می‌توانید دسترسی به مسیرها را محدود کنید.

– مدیریت سطوح دسترسی
پیاده‌سازی نقش‌های کاربری (مثلاً admin و user عادی) و کنترل مجوزها بر اساس نقش، از طریق وابستگی‌های FastAPI قابل پیاده‌سازی است. این کار امنیت پروژه را به شکل قابل توجهی افزایش می‌دهد.

H2: تست و استقرار REST API

– تست واحد و یکپارچه
برای کیفیت کد، از pytest استفاده کنید و توابع test به صورت isolated بنویسید. با FastAPI می‌توانید درخواست‌های تستی را به راحتی شبیه‌سازی کنید:
from fastapi.testclient import TestClient

def test_read_main():
client = TestClient(app)
response = client.get(“/users/”)
assert response.status_code == 200

– استقرار و عملکرد در محیط تولید
برای استقرار در محیط‌های تولید، uvicorn با Gunicorn یا uvicorn workers پیکربندی می‌شود تا کارایی و مقیاس‌پذیری بهینه شود. همچنین انتخاب محیط ابری مانند AWS یا Heroku یا سایر سرویس‌ها بستگی به بودجه و نیاز پروژه دارد.

H2: بهترین شیوه‌ها و نکات تکمیلی

– مدل دقیق‌تر برای ورودی‌ها و خروجی‌ها تعریف کنید تا استفاده‌کنندگان API بدانند چه داده‌ای را باید ارسال یا انتظار داشته باشند.
– از نسخه‌بندی API استفاده کنید تا تغییرات در آینده به‌راحتی با نسخه‌های مختلف مدیریت شوند.
– کد را ماژولار نگه دارید: جداکردن مکانیزم‌های اعتبارسنجی، مدیریت پایگاه داده و منطق کسب‌وکار، نگهداری پروژه را ساده‌تر می‌کند.
– تست‌های کافی بنویسید و CI/CD را پیاده‌سازی کنید تا تغییرات به درستی ارزیابی شوند.
– مستندسازی خودکار را فعال نگه دارید (Swagger UI یا ReDoc) تا کاربران و توسعه‌دهندگان بتوانند به راحتی به API دسترسی پیدا کنند.

H2: جمع‌بندی

راه‌اندازی REST API با FastAPI به دلیل کارایی، سهولت استفاده و ابزارهای built-in برای اعتبارسنجی داده‌ها و مستندسازی، گزینه‌ای بسیار مطلوب است. با پیاده‌سازی مسیرهای RESTful، مدل‌های داده با Pydantic، اتصال به دیتابیس از طریق ORM، و افزودن لایه‌های امنیتی، می‌توانید APIهایی با کیفیت، امن و مقیاس‌پذیر بسازید که هم تیمی‌ها و هم کاربران نهایی از کار با آن رضایت داشته باشند. FastAPI نه تنها سرعت توسعه را افزایش می‌دهد بلکه با استانداردها و بهترین شیوه‌های توسعه داده‌های REST، به شما کمک می‌کند پروژه‌های پیچیده را به صورت ساخت‌یافته و پایدار مدیریت کنید.