این معماری چگونه کار می‌کند؟

بهترین رویکرد برای RESTful API شامل چهار عملیات است:

  • دریافت داده از یک فرمت مناسب
  • ایجاد داده جدید
  • تغییر و بروزرسانی داده
  • حذف کردن داده

REST به شدت مبتنی بر HTTP است. قرار نیست که ما در ارتباط با این پروتکل توضیحی ارائه دهیم اما به نظر ارزشمند است که اگر بتوانیم اشاره‌ای به روند‌های اجرا عملیات‌های بالا در HTTP بکنیم.
هر کدام از عملیات‌های بالا حاوی متد HTTP منحصر به فرد خودشان هستند:

  • GET – متدی برای دریافت اطلاعات
  • POST – متدی برای ایجاد داده
  • PUT – متدی برای بروزرسانی و ایجاد تغییرات در داده
  • DELETE – متدی برای حذف

به صورت کلی به تمام این عملیات‌ها CRUD نیز گفته می‌شود که ما در بانک‌های اطلاعاتی با آن سر و کار داریم. این چهار عملیات، داده‌های ما را مدیریت می‌کنند.
REST یک رابط برای مدیریت درخواست‌ها و ارتباط با بانک اطلاعاتی دارد که می‌شود در جدول زیر آن را به صورت کلی مشاهده کرد:


content request methods

تمام درخواست‌ها، حاوی جواب‌های منحصر به فرد خودشان هستند. این جواب‌ها از طریق یکسری کد ارائه می‌شوند که تعداد آن‌ها بسیار زیاد است. اما می‌شود آن‌ها را در ۵ کلاس دسته بندی کرد. عدد اول هر کلاس نمایانگر پیغامی است که زیرکلاس‌های آن ارائه می‌دهند:

  • ۱xx - informational;
  • ۲xx - success;
  • ۳xx - redirection;
  • ۴xx - client error;
  • ۵xx - server error.

اطلاعات بیشتر در ارتباط با این کدها را می‌توانید در این صفحه مشاهده کنید.

نسخه بندی

شما همیشه باید برای REST APIهای خودتان نسخه بندی مناسبی طراحی بکنید. برای مثال اگر URL مربوط به API شما

کد:
 http://example.com/api
است، باید آن را به صورت

کد:
http://example.com/api/v۱
تغییر بدهید.