Good APIs Vs Bad APIs: 7 Tips for API Design — Transcript
Full transcript
- 0:00قد يكون تصميم واجهات
- 0:01برمجة تطبيقات (RESTful API)
- 0:02فعالة وآمنة أمراً
- 0:03معقداً. في هذا
- 0:04الفيديو، سنستعرض
- 0:05أفضل الممارسات
- 0:06لتصميم واجهات برمجة
- 0:07تطبيقات قوية يحبها
- 0:08المطورون وتعتمد
- 0:09عليها الشركات على
- 0:10المدى الطويل. نحن
- 0:11نستخدم واجهات برمجة
- 0:12التطبيقات يومياً،
- 0:13ومعظم الناس لا يدركون
- 0:14ذلك حتى. فهي تشغل
- 0:15خدمات مثل نشر
- 0:16المنشورات الاجتماعية
- 0:17، والتحقق من الطقس،
- 0:18وحجز الرحلات، وغيرها.
- 0:19تدعم هذه الواجهات
- 0:20جزءاً كبيراً من تجارب
- 0:21تطبيقاتنا الحديثة،
- 0:22لذا دعونا نبدأ مباشرة
- 0:23. النصيحة الأولى:
- 0:25استخدم تسميات واضحة.
- 0:26عند بناء واجهة برمجة
- 0:27تطبيقات، اختر أسماء
- 0:29مباشرة ومنطقية. بدلاً
- 0:30من استخدام get cart 123
- 0:32لتطبيق تسوق، استخدم
- 0:34carts 123. صيغة الجمع تخبر
- 0:36مستخدمي الواجهة أنهم
- 0:37يتعاملون مع مجموعة من
- 0:38الموارد. كن متسقاً.
- 0:40التزم بعناوين URL
- 0:41بديهية تشير إلى
- 0:42المجموعات. هذا يجعل
- 0:44التفاعل أكثر فهماً
- 0:45للمطورين الذين
- 0:46يستخدمون واجهتك
- 0:47البرمجية. النصيحة
- 0:48الثانية: ضمان
- 0:49الموثوقية من خلال
- 0:50واجهات ذات تأثير
- 0:51محايد (Idempotent). تعني
- 0:53خاصية "الإيديمبوتنس"
- 0:54أن إجراء نفس الطلب
- 0:55عدة مرات له نفس تأثير
- 0:57إجرائه مرة واحدة. هذا
- 0:58المفهوم هو مفتاح
- 0:59الحصول على واجهات
- 1:01موثوقة. فهو يمنع
- 1:02الأخطاء في حال إعادة
- 1:03إرسال الطلبات، وهو
- 1:04أمر شائع. عادةً،
- 1:05طلبات POST التي تنشئ
- 1:07موارد ليست ذات تأثير
- 1:08محايد بطبيعتها. إرسال
- 1:10نفس طلب POST مرتين قد
- 1:11يؤدي إلى تكرار ذلك
- 1:13المورد. يمكننا إضافة
- 1:15منطق لمنع التكرار عبر
- 1:16طلب معرف فريد من جهة
- 1:18العميل لكل طلب. طلبات
- 1:20GET التي تقرأ البيانات
- 1:21هي ذات تأثير محايد
- 1:22افتراضياً. تكرار
- 1:23طلبات GET يعيد دائماً
- 1:25نفس المعلومات دون
- 1:26تغيير. طلبات PUT التي
- 1:27تُحدّث الموارد
- 1:28بالكامل تميل أيضاً
- 1:30لأن تكون ذات تأثير
- 1:31محايد. يُستخدم PATCH
- 1:32عادةً لتغيير حقول
- 1:34محددة داخل المورد.
- 1:35على سبيل المثال، قد
- 1:36يؤدي استخدام PATCH
- 1:37لإضافة مصفوفة إلى
- 1:39تكرار عناصرها إذا تم
- 1:40استدعاؤه عدة مرات.
- 1:41هذا يعني أن PATCH قد لا
- 1:42يكون ذا تأثير محايد.
- 1:44أخيراً، طلبات DELETE هي
- 1:45ذات تأثير محايد.
- 1:46الحذف يتم مرة واحدة
- 1:47فقط، حتى لو تم
- 1:48استدعاؤه بشكل متكرر.
- 1:49الاستدعاءات اللاحقة
- 1:50تعيد أخطاء إذا تم
- 1:51الحذف بالفعل. النصيحة
- 1:52الثالثة هي إضافة نظام
- 1:53الإصدارات (Versioning). مع
- 1:55نمو واجهتك البرمجية
- 1:56والحاجة لتحديثها،
- 1:57ستحتاج لإجراء
- 1:58تغييرات دون كسر
- 1:59التطبيقات التي
- 2:00تستخدمها بالفعل.
- 2:01عنوان URL مثل V1/carts/123
- 2:03يتيح لك تقديم إصدارات
- 2:05جديدة مثل V2 دون
- 2:07التأثير على مستخدمي
- 2:09إصدارك الحالي. تسمح
- 2:11الإصدارات بتحديث
- 2:12الواجهات مع دعم
- 2:13التوافق مع الإصدارات
- 2:14السابقة. هذا يتيح
- 2:15للمطورين الذين
- 2:16يستخدمون الإصدارات
- 2:17القديمة الترقية وفق
- 2:19جدولهم الزمني الخاص.
- 2:20نسّق التغييرات أيضاً
- 2:21من خلال ملاحظات إصدار
- 2:22موثقة جيداً. النصيحة
- 2:24الرابعة هي إضافة
- 2:25خاصية الترقيم (Pagination).
- 2:26تتحكم هذه الخاصية في
- 2:27كمية البيانات التي
- 2:28تعيدها الواجهة. طرق
- 2:30الترقيم الشائعة هي
- 2:31الترقيم بالصفحات مع
- 2:32الإزاحة (offset) أو
- 2:33الاعتماد على المؤشر (
- 2:34cursor). يعتمد ترقيم
- 2:35الصفحات بالإزاحة على
- 2:36أرقام الصفحات وحدود
- 2:37حجم الصفحة. على سبيل
- 2:39المثال، الصفحة
- 2:40الثانية ستعرض
- 2:41السجلات من 11 إلى 20
- 2:42بحجم 10 سجلات. هذه
- 2:43الطريقة بسيطة، لكنها
- 2:44قد تكون بطيئة مع
- 2:45مجموعات البيانات
- 2:46الضخمة لأن قاعدة
- 2:47البيانات تضطر لحساب
- 2:48كل الصفوف من البداية
- 2:50وصولاً للصفحة
- 2:51المطلوبة. تستخدم
- 2:52الصفحات المستندة إلى
- 2:53المؤشر مؤشرًا لجلب
- 2:54المجموعة التالية من
- 2:55السجلات. فهي تتتبع
- 2:56الصفحات بدقة حتى مع
- 2:58معدل تغيير مرتفع في
- 2:59البيانات. كلا النهجين
- 3:01يمنعان إغراق مستهلكي
- 3:02واجهة برمجة
- 3:03التطبيقات بجميع
- 3:04البيانات دفعة واحدة.
- 3:05هذا يعزز الأداء ويحسن
- 3:07تجربة المستخدم.
- 3:08النصيحة رقم خمسة هي
- 3:10استخدام سلاسل
- 3:10استعلام واضحة لفرز
- 3:11وتصفية بيانات واجهة
- 3:12برمجة التطبيقات. إذا
- 3:14أراد مستخدم الفرز حسب
- 3:15تاريخ التسجيل، أضف
- 3:16معامل فرز بسيط مثل "sort
- 3:18= registered". هل تحتاج فقط
- 3:19إلى المنتجات الزرقاء
- 3:20؟ جرب استخدام عامل
- 3:22التصفية "color = blue". ما
- 3:23هي الفوائد؟ أولاً،
- 3:24تجعل سلاسل الاستعلام
- 3:26بيانات الاستجابة
- 3:27سهلة الفهم. يرى
- 3:28المطور على الفور
- 3:29عوامل التصفية النشطة
- 3:30أو ترتيب الفرز المطبق
- 3:32. ثانياً، يسهل إضافة
- 3:33معايير فرز وتصفية
- 3:35إضافية بمرور الوقت
- 3:36دون كسر عمليات
- 3:37التكامل الحالية.
- 3:38ثالثاً، يمكن تخزين
- 3:39مجموعات النتائج
- 3:40المصفاة والمرتبة
- 3:41مؤقتًا بشكل منفصل
- 3:42لزيادة السرعة.
- 3:43النصيحة رقم ستة، لا
- 3:44تجعل الأمان فكرة
- 3:45ثانوية عند تصميم
- 3:46واجهات برمجة
- 3:47التطبيقات. بالنسبة
- 3:48للاعتمادات الحساسة
- 3:49مثل مفاتيح API، استفد
- 3:51من رؤوس HTTP بدلاً من
- 3:52عناوين URL. يتم تسجيل
- 3:53عناوين URL في سجل وصول
- 3:55الخادم، مما يكشف السر
- 3:56كنص عادي. الرؤوس مثل "
- 3:58Authorization" تقلل من هذا
- 3:59الخطر. لكن الرؤوس لا
- 4:01تزال قادرة على التسرب
- 4:02، لذا افرض تشفير TLS
- 4:03الكامل لجميع الحركات
- 4:04لحماية الإرسال من
- 4:05البداية للنهاية. نفذ
- 4:06ضوابط وصول قوية. تحقق
- 4:09من المفاتيح والرموز
- 4:10في كل طلب قبل
- 4:11المعالجة. الأمان
- 4:12موضوع عميق. لقد
- 4:14تطرقنا فقط إلى القشور
- 4:15. تأكد من مواكبة أحدث
- 4:17الممارسات الموصى بها.
- 4:18النصيحة رقم سبعة،
- 4:20اجعل المراجع بين
- 4:21الموارد بسيطة. استخدم
- 4:23روابط واضحة بين
- 4:24الموارد المتصلة. لا
- 4:25تزدحم الأمور بسلاسل
- 4:27استعلام طويلة. على
- 4:28سبيل المثال، أشر إلى
- 4:30العنصر 321 داخل العربة
- 4:32123 من خلال مسار نظيف
- 4:34كهذا. هذا يتجنب
- 4:35معاملات الاستعلام
- 4:36الفوضوية مثل التي
- 4:37نراها على الشاشة.
- 4:38المسارات المباشرة
- 4:39تجعل الارتباطات
- 4:40واضحة للمطور الذي
- 4:41يستخدم واجهة برمجة
- 4:42التطبيقات. النصيحة
- 4:44الأخيرة، خطط لتحديد
- 4:45معدل الطلبات. هذا
- 4:46يحمي واجهات برمجة
- 4:47التطبيقات من التحميل
- 4:48الزائد أو سوء
- 4:49الاستخدام. حدد حصص
- 4:50طلبات بناءً على أبعاد
- 4:51مثل عناوين IP المصدر،
- 4:53أو حسابات المستخدمين
- 4:54، أو فئات نقاط
- 4:55النهاية. على سبيل
- 4:56المثال، قد يحصل عملاء
- 4:58المستوى المجاني على
- 4:591000 طلب يوميًا، ويتم
- 5:00تحديد كل عنوان IP بـ 20
- 5:02مكالمة في الدقيقة.
- 5:03هذه الحصص لا تحمي
- 5:04البنية التحتية فحسب،
- 5:06بل تشجع الاستخدام
- 5:07العادل كجزء من عقد
- 5:08الخدمة عبر جميع
- 5:09العملاء. كما أنها
- 5:11تقلل من مساحة الهجوم
- 5:13من هجمات DDoS. تصميم
- 5:14واجهة برمجة
- 5:15التطبيقات لا يتعلق
- 5:16فقط بجعلها تعمل. بل
- 5:17يتعلق بجعلها تعمل
- 5:19بشكل جيد وآمن. من خلال
- 5:21مراعاة اتفاقيات REST
- 5:23وأفضل الممارسات التي
- 5:25ناقشناها، ستنشئ
- 5:26واجهات برمجة تطبيقات
- 5:28قوية وموثوقة وممتعة
- 5:30للمطورين. إذا أعجبتك
- 5:32فيديوهاتنا، فقد
- 5:33تعجبك نشرتنا
- 5:33الإخبارية حول تصميم
- 5:35الأنظمة أيضًا. إنها
- 5:36تغطي مواضيع واتجاهات
- 5:38في تصميم الأنظمة
- 5:39واسعة النطاق، ويثق
- 5:40بها 500,000 قارئ. اشترك
- 5:42عبر blog.bytebytego.com.
About this transcript
This page contains the full transcript of Good APIs Vs Bad APIs: 7 Tips for API Design by ByteByteGo, generated from the public captions YouTube serves with the video. The transcript has 877 words across 272 segments, with the original timestamps preserved so you can click any line to jump to that moment in the embedded player.
What you can do with it
Use the transcript to take notes, quote the speaker, build a study guide, generate a summary with ChatGPT or Claude via the YouTube Summary tool, or export it as a timed subtitle file with YouTube to SRT. You can also re-open it in the transcriber to choose a caption track available on the video.
Free YouTube transcript tool
YouTube2Text is a free YouTube transcript generator — no signup, no daily limit. Paste any YouTube link and get the full transcript instantly, with timestamps, click-to-jump, caption language selection, AI prompts for ChatGPT, Claude, and Gemini, and exports to TXT, SRT, VTT, or Markdown.