مفاهیم پایه REST

REST (Representational State Transfer) و APIهای RESTful مفاهیم کلیدی در طراحی و توسعه وب‌سرویس‌ها هستند. این مفاهیم به توسعه‌دهندگان کمک می‌کنند تا وب‌سرویس‌هایی ایجاد کنند که قابل فهم، قابل استفاده و قابل توسعه هستند.

مفاهیم پایه REST

• Resource: هر چیزی که قابل شناسایی و قابل دستکاری باشد، یک resource محسوب می‌شود. مثلاً یک کاربر، یک پست، یک محصول و غیره.
• Representation: نحوه نمایش یک resource. این می‌تواند به شکل JSON، XML، HTML یا هر فرمت دیگری باشد.
• State: وضعیت یک resource در یک زمان خاص.
• Client-Server Architecture: ساختاری که در آن یک client درخواست می‌کند و یک server پاسخ می‌دهد.

اصول طراحی APIهای RESTful

APIهای RESTful باید به اصول زیر پایبند باشند:

۱. معماری کلاینت-سرور (Client-Server Architecture):

• • تکامل مستقل: کلاینت و سرور می‌توانند به طور مستقل توسعه داده شوند و تغییر کنند.
  • مسئولیت‌های مشخص: کلاینت مسئول تعامل با کاربر و نمایش داده‌ها است و سرور مسئول مدیریت منابع است.

۲. بی‌حالت بودن (Statelessness):

• • هر درخواست مستقل است: هر درخواست از سمت کلاینت باید حاوی تمام اطلاعات لازم برای پردازش باشد.
  • عدم ذخیره وضعیت: سرور نباید اطلاعاتی را در مورد وضعیت ارتباط قبلی ذخیره کند.

۳. قابلیت کش شدن (Cacheability):

• • بهبود عملکرد: پاسخ‌هایی که قابل کش شدن هستند، می‌توانند برای کاهش بار سرور و بهبود زمان پاسخگویی استفاده شوند.
  • سرور کنترل می‌کند: سرور تعیین می‌کند که کدام پاسخ‌ها قابل کش شدن هستند و مدت زمان اعتبار آن‌ها چقدر است.

۴. رابط یکنواخت (Uniform Interface):

• • روش‌های استاندارد HTTP: استفاده از روش‌های HTTP مانند GET، POST، PUT، DELETE برای انجام عملیات مختلف.
  • شناسایی منابع با URI: استفاده از URI‌های قابل فهم برای شناسایی منابع.
  • فرمت‌های استاندارد برای داده‌ها: استفاده از فرمت‌های استاندارد مانند JSON یا XML برای تبادل داده.

۵. سیستم لایه بندی (Layered System):

• • جداسازی نگرانی‌ها: لایه‌های مختلف سیستم وظایف متفاوتی را انجام می‌دهند و از هم مستقل هستند.
  • افزایش انعطاف‌پذیری: هر لایه می‌تواند به صورت مستقل توسعه داده و تغییر کند.

۶. کد به عنوان داده (Code on Demand):

• • گسترش قابلیت‌ها: در برخی موارد، سرور می‌تواند کد را به کلاینت ارسال کند تا قابلیت‌های آن را گسترش دهد.
  • استفاده محدود: این اصل به ندرت استفاده می‌شود و باید با احتیاط انجام شود.

روش‌های HTTP در APIهای RESTful

• در APIهای RESTful، از روش‌های HTTP برای مشخص کردن نوع عملیاتی که روی یک منبع (resource) انجام می‌شود، استفاده می‌شود. هر روش HTTP نشان‌دهنده یک عمل خاص است. در ادامه به بررسی مهم‌ترین روش‌های HTTP در APIهای RESTful می‌پردازیم:

  روش‌های اصلی HTTP در RESTful APIها

  • GET:

    • برای دریافت اطلاعات یک منبع استفاده می‌شود.
    • این روش ایمن است و نباید باعث تغییر در حالت سرور شود.
    • مثال: GET /users/1 برای دریافت اطلاعات کاربر با شناسه ۱.

  • POST:

    • برای ایجاد یک منبع جدید استفاده می‌شود.
    • معمولاً داده‌های جدید را در بدنه درخواست ارسال می‌کنیم.
    • مثال: POST /users برای ایجاد یک کاربر جدید.

  • PUT:

    • برای به‌روزرسانی کامل یک منبع موجود استفاده می‌شود.
    • تمام اطلاعات جدید در بدنه درخواست ارسال می‌شود.
    • مثال: PUT /users/1 برای به‌روزرسانی کامل اطلاعات کاربر با شناسه ۱.

  • DELETE:

    • برای حذف یک منبع استفاده می‌شود.
    • مثال: DELETE /users/1 برای حذف کاربر با شناسه ۱.

  • PATCH:

    • برای به‌روزرسانی جزئی یک منبع استفاده می‌شود.
    • فقط اطلاعاتی که نیاز به تغییر دارند در بدنه درخواست ارسال می‌شود.
    • مثال: PATCH /users/1 برای تغییر آدرس ایمیل کاربر با شناسه ۱.

  سایر روش‌های HTTP (کمتر استفاده می‌شوند)

  • HEAD: شبیه به GET است اما فقط هدرهای پاسخ را برمی‌گرداند.
  • OPTIONS: برای دریافت اطلاعات در مورد قابلیت‌های یک منبع استفاده می‌شود.
  • CONNECT: برای ایجاد یک تونل پروکسی استفاده می‌شود.
  • TRACE: برای عیب‌یابی استفاده می‌شود و درخواست را به صورت خام بازمی‌گرداند.

  انتخاب روش مناسب

  انتخاب روش HTTP مناسب برای هر درخواست، بستگی به عملیاتی دارد که می‌خواهیم روی منبع انجام دهیم. به عنوان مثال:

  • اگر می‌خواهیم اطلاعات یک کاربر را دریافت کنیم، از روش GET استفاده می‌کنیم.
  • اگر می‌خواهیم یک کاربر جدید ایجاد کنیم، از روش POST استفاده می‌کنیم.
  • اگر می‌خواهیم اطلاعات یک کاربر موجود را به‌طور کامل به‌روزرسانی کنیم، از روش PUT استفاده می‌کنیم.
  • اگر می‌خواهیم فقط بخشی از اطلاعات یک کاربر را به‌روزرسانی کنیم، از روش PATCH استفاده می‌کنیم.
  • اگر می‌خواهیم یک کاربر را حذف کنیم، از روش DELETE استفاده می‌کنیم.

• مثال عملی

  فرض کنید یک API برای مدیریت کتاب‌ها داریم. برخی از endpointهای این API به همراه روش‌های HTTP مناسب عبارتند از:

  • GET /books: لیست تمام کتاب‌ها را برمی‌گرداند.
  • POST /books: کتاب جدیدی را ایجاد می‌کند.
  • GET /books/{id}: اطلاعات یک کتاب خاص را برمی‌گرداند.
  • PUT /books/{id}: اطلاعات یک کتاب خاص را به‌طور کامل به‌روزرسانی می‌کند.
  • PATCH /books/{id}: بخشی از اطلاعات یک کتاب خاص را به‌روزرسانی می‌کند.
  • DELETE /books/{id}: یک کتاب خاص را حذف می‌کند.

  توجه: انتخاب روش‌های HTTP مناسب، نه تنها به درستی عملکرد API کمک می‌کند، بلکه باعث می‌شود API شما قابل فهم‌تر و قابل پیش‌بینی‌تر باشد.

مثال: فرض کنید می‌خواهیم یک API RESTful برای مدیریت کاربران ایجاد کنیم.

• Resource: User
• Representations: JSON یا XML
• Endpoints:
  • /users: لیست کاربران
  • /users/{id}: اطلاعات یک کاربر خاص
  • /users: ایجاد یک کاربر جدید (POST)
  • /users/{id}: به‌روزرسانی یک کاربر (PUT)
  • /users/{id}: حذف یک کاربر (DELETE)

با استفاده از این اصول و روش‌ها، می‌توانید APIهای RESTful قدرتمند و قابل استفاده ایجاد کنید که به توسعه‌دهندگان و مصرف‌کنندگان خدمات شما کمک می‌کند.