What REST is, in three facts

ما هو REST، في ثلاث حقائق

Slide 17 gives the whole definition. REST stands for REpresentational State Transfer. It was introduced by Roy Thomas Fielding in his doctoral dissertation in 2000. Memorise the name, the person and the year together, because a true/false question can change any one of them.

الشريحة 17 تعطي التعريف كاملاً. REST اختصار لـ Representational State Transfer. قدّمه Roy Thomas Fielding في رسالة الدكتوراه عام 2000. احفظ الاسم والشخص والسنة معاً، لأن سؤال صح أو خطأ قد يغيّر أياً منها.

1. REST is an architectural style, not a protocol. It is a set of design rules for web-based APIs. HTTP is the protocol; REST tells you how to use HTTP well.

   REST أسلوب معماري (architectural style) وليس بروتوكولاً. هو مجموعة قواعد تصميم لواجهات API على الويب. البروتوكول هو HTTP، وREST يخبرك كيف تستخدم HTTP بشكل صحيح.

2. REST leverages HTTP to design scalable, stateless APIs. The slide's summary box: "REST is a design style that uses HTTP properly to build scalable, stateless APIs."

   REST يستفيد من HTTP لتصميم واجهات قابلة للتوسع (scalable) وعديمة الحالة (stateless). وملخص الشريحة: REST أسلوب تصميم يستخدم HTTP كما ينبغي لبناء واجهات قابلة للتوسع وعديمة الحالة.

3. Statelessness means two things: the server does not store client session data, and every request must contain all the necessary information.

   انعدام الحالة يعني أمرين: الخادم لا يحفظ بيانات جلسة العميل (session data)، وكل طلب يجب أن يحمل كل المعلومات اللازمة لمعالجته.

Six constraints: five mandatory, one optional

ستة قيود: خمسة إلزامية وواحد اختياري

Slides 18 and 19 list the constraints. An API is only "RESTful" if it obeys the five mandatory ones. The sixth, code on demand, is the only optional constraint.

تسرد الشريحتان 18 و19 القيود. لا تُسمّى الواجهة RESTful إلا إذا التزمت بالقيود الخمسة الإلزامية. أما السادس، code on demand، فهو القيد الاختياري الوحيد.

الرسم يتتبّع طلب PATCH واحداً للمصباح 123. الأرقام تبيّن أين يعمل كل قيد: 1 الفصل بين التطبيق والخادم، 2 و4 داخل الطلب، 3 و4 داخل الاستجابة، 5 البوابة في المنتصف، و6 شيفرة اختيارية يرسلها الخادم.

يجمع هذا الجدول القيود الستة كما وردت في الشريحتين، مع مثال المصباح لكل قيد. ركّز على العمود الأخير لأن أسئلة matching تعطيك المثال وتطلب القيد. لاحظ أن القيود من 1 إلى 5 إلزامية، وأن Code on Demand وحده اختياري.

Statelessness, precisely

الـ Statelessness بدقة

"Stateless" does not mean the server holds no data. The server definitely stores the lamp: it is ON, brightness 80. What it does not store is session state, meaning memory of what this particular client did in earlier requests. Compare two designs for "set lamp 123 to 80":

كلمة stateless لا تعني أن الخادم لا يحمل أي بيانات. الخادم بالتأكيد يحفظ المصباح: مُشغَّل، والسطوع 80. ما لا يحفظه هو حالة الجلسة (session state)، أي ذاكرة ما فعله هذا العميل بالذات في طلبات سابقة. قارن تصميمين لعملية "اجعل المصباح 123 على 80":

1. LOGIN user=majid
2. SELECT lamp 123
3. SET brightness 80

PATCH /lamps/123
Authorization: Bearer eyJ...
{ "brightness": 80 }

Cacheability, worked

الـ Cacheability بمثال محلول

requests at t = 0, 10, 20, ..., 110 s   -> 120 / 10 = 12 requests
t = 0      cache empty         -> server   (copy stored, fresh until age 60)
t = 10..50 age 10..50 < 60     -> cache    (5 requests)
t = 60     age 60, not fresh   -> server   (new copy stored)
t = 70..110 age 10..50 < 60    -> cache    (5 requests)

server hits = 2,  cache hits = 10,  load cut = 10 / 12 = 83%

Uniform interface: the four subconstraints

الواجهة الموحّدة: القيود الفرعية الأربعة

Constraint 4 is the one with internal structure, and the slide gives a lamp example for each of its four parts. Expect a matching question here.

القيد الرابع هو الوحيد الذي له بنية داخلية، والشريحة تعطي مثال مصباح لكل جزء من أجزائه الأربعة. توقّع سؤال matching هنا.

هذا الجدول يفصّل القيد الرابع إلى أجزائه الأربعة. الفرق الدقيق بين الثاني والثالث: manipulation through representations يتعلق بأنك تغيّر المورد بإرسال تمثيل له (JSON)، بينما self-descriptive messages يتعلق بأن الرسالة تشرح نفسها بالطريقة والترويسات ونوع المحتوى. وHATEOAS يعني أن الاستجابة نفسها تخبر العميل بما يمكنه فعله بعد ذلك عبر روابط.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 123,
  "ON": true,
  "brightness": 80,
  "links": [
    { "rel": "self",   "method": "GET",    "href": "/lamps/123" },
    { "rel": "update", "method": "PATCH",  "href": "/lamps/123" },
    { "rel": "delete", "method": "DELETE", "href": "/lamps/123" }
  ]
}

That links array is HATEOAS: the client does not need to hard-code what it may do next, because the server tells it.

مصفوفة links هذه هي HATEOAS: لا يحتاج العميل إلى تثبيت الخطوات التالية في شيفرته، لأن الخادم يخبره بها.

Matching drill: example to constraint

تدريب توصيل: المثال مقابل القيد

هذا تمرين matching: كل سيناريو في العمود الأول يقابله قيد في العمود الثاني. غطِّ العمود الثاني وحاول الإجابة. انتبه أن أربعة سيناريوهات كلها تنتمي إلى القيد نفسه (uniform interface)، وأن HATEOAS ليس قيداً سابعاً بل جزء من القيد الرابع.