YouTube2Text

Good APIs Vs Bad APIs: 7 Tips for API Design — Transcript

by ByteByteGo · 877 words · 272 segments · language en · Watch on YouTube

Full transcript

  1. 0:00قد يكون تصميم واجهات
  2. 0:01برمجة تطبيقات (RESTful API)
  3. 0:02فعالة وآمنة أمراً
  4. 0:03معقداً. في هذا
  5. 0:04الفيديو، سنستعرض
  6. 0:05أفضل الممارسات
  7. 0:06لتصميم واجهات برمجة
  8. 0:07تطبيقات قوية يحبها
  9. 0:08المطورون وتعتمد
  10. 0:09عليها الشركات على
  11. 0:10المدى الطويل. نحن
  12. 0:11نستخدم واجهات برمجة
  13. 0:12التطبيقات يومياً،
  14. 0:13ومعظم الناس لا يدركون
  15. 0:14ذلك حتى. فهي تشغل
  16. 0:15خدمات مثل نشر
  17. 0:16المنشورات الاجتماعية
  18. 0:17، والتحقق من الطقس،
  19. 0:18وحجز الرحلات، وغيرها.
  20. 0:19تدعم هذه الواجهات
  21. 0:20جزءاً كبيراً من تجارب
  22. 0:21تطبيقاتنا الحديثة،
  23. 0:22لذا دعونا نبدأ مباشرة
  24. 0:23. النصيحة الأولى:
  25. 0:25استخدم تسميات واضحة.
  26. 0:26عند بناء واجهة برمجة
  27. 0:27تطبيقات، اختر أسماء
  28. 0:29مباشرة ومنطقية. بدلاً
  29. 0:30من استخدام get cart 123
  30. 0:32لتطبيق تسوق، استخدم
  31. 0:34carts 123. صيغة الجمع تخبر
  32. 0:36مستخدمي الواجهة أنهم
  33. 0:37يتعاملون مع مجموعة من
  34. 0:38الموارد. كن متسقاً.
  35. 0:40التزم بعناوين URL
  36. 0:41بديهية تشير إلى
  37. 0:42المجموعات. هذا يجعل
  38. 0:44التفاعل أكثر فهماً
  39. 0:45للمطورين الذين
  40. 0:46يستخدمون واجهتك
  41. 0:47البرمجية. النصيحة
  42. 0:48الثانية: ضمان
  43. 0:49الموثوقية من خلال
  44. 0:50واجهات ذات تأثير
  45. 0:51محايد (Idempotent). تعني
  46. 0:53خاصية "الإيديمبوتنس"
  47. 0:54أن إجراء نفس الطلب
  48. 0:55عدة مرات له نفس تأثير
  49. 0:57إجرائه مرة واحدة. هذا
  50. 0:58المفهوم هو مفتاح
  51. 0:59الحصول على واجهات
  52. 1:01موثوقة. فهو يمنع
  53. 1:02الأخطاء في حال إعادة
  54. 1:03إرسال الطلبات، وهو
  55. 1:04أمر شائع. عادةً،
  56. 1:05طلبات POST التي تنشئ
  57. 1:07موارد ليست ذات تأثير
  58. 1:08محايد بطبيعتها. إرسال
  59. 1:10نفس طلب POST مرتين قد
  60. 1:11يؤدي إلى تكرار ذلك
  61. 1:13المورد. يمكننا إضافة
  62. 1:15منطق لمنع التكرار عبر
  63. 1:16طلب معرف فريد من جهة
  64. 1:18العميل لكل طلب. طلبات
  65. 1:20GET التي تقرأ البيانات
  66. 1:21هي ذات تأثير محايد
  67. 1:22افتراضياً. تكرار
  68. 1:23طلبات GET يعيد دائماً
  69. 1:25نفس المعلومات دون
  70. 1:26تغيير. طلبات PUT التي
  71. 1:27تُحدّث الموارد
  72. 1:28بالكامل تميل أيضاً
  73. 1:30لأن تكون ذات تأثير
  74. 1:31محايد. يُستخدم PATCH
  75. 1:32عادةً لتغيير حقول
  76. 1:34محددة داخل المورد.
  77. 1:35على سبيل المثال، قد
  78. 1:36يؤدي استخدام PATCH
  79. 1:37لإضافة مصفوفة إلى
  80. 1:39تكرار عناصرها إذا تم
  81. 1:40استدعاؤه عدة مرات.
  82. 1:41هذا يعني أن PATCH قد لا
  83. 1:42يكون ذا تأثير محايد.
  84. 1:44أخيراً، طلبات DELETE هي
  85. 1:45ذات تأثير محايد.
  86. 1:46الحذف يتم مرة واحدة
  87. 1:47فقط، حتى لو تم
  88. 1:48استدعاؤه بشكل متكرر.
  89. 1:49الاستدعاءات اللاحقة
  90. 1:50تعيد أخطاء إذا تم
  91. 1:51الحذف بالفعل. النصيحة
  92. 1:52الثالثة هي إضافة نظام
  93. 1:53الإصدارات (Versioning). مع
  94. 1:55نمو واجهتك البرمجية
  95. 1:56والحاجة لتحديثها،
  96. 1:57ستحتاج لإجراء
  97. 1:58تغييرات دون كسر
  98. 1:59التطبيقات التي
  99. 2:00تستخدمها بالفعل.
  100. 2:01عنوان URL مثل V1/carts/123
  101. 2:03يتيح لك تقديم إصدارات
  102. 2:05جديدة مثل V2 دون
  103. 2:07التأثير على مستخدمي
  104. 2:09إصدارك الحالي. تسمح
  105. 2:11الإصدارات بتحديث
  106. 2:12الواجهات مع دعم
  107. 2:13التوافق مع الإصدارات
  108. 2:14السابقة. هذا يتيح
  109. 2:15للمطورين الذين
  110. 2:16يستخدمون الإصدارات
  111. 2:17القديمة الترقية وفق
  112. 2:19جدولهم الزمني الخاص.
  113. 2:20نسّق التغييرات أيضاً
  114. 2:21من خلال ملاحظات إصدار
  115. 2:22موثقة جيداً. النصيحة
  116. 2:24الرابعة هي إضافة
  117. 2:25خاصية الترقيم (Pagination).
  118. 2:26تتحكم هذه الخاصية في
  119. 2:27كمية البيانات التي
  120. 2:28تعيدها الواجهة. طرق
  121. 2:30الترقيم الشائعة هي
  122. 2:31الترقيم بالصفحات مع
  123. 2:32الإزاحة (offset) أو
  124. 2:33الاعتماد على المؤشر (
  125. 2:34cursor). يعتمد ترقيم
  126. 2:35الصفحات بالإزاحة على
  127. 2:36أرقام الصفحات وحدود
  128. 2:37حجم الصفحة. على سبيل
  129. 2:39المثال، الصفحة
  130. 2:40الثانية ستعرض
  131. 2:41السجلات من 11 إلى 20
  132. 2:42بحجم 10 سجلات. هذه
  133. 2:43الطريقة بسيطة، لكنها
  134. 2:44قد تكون بطيئة مع
  135. 2:45مجموعات البيانات
  136. 2:46الضخمة لأن قاعدة
  137. 2:47البيانات تضطر لحساب
  138. 2:48كل الصفوف من البداية
  139. 2:50وصولاً للصفحة
  140. 2:51المطلوبة. تستخدم
  141. 2:52الصفحات المستندة إلى
  142. 2:53المؤشر مؤشرًا لجلب
  143. 2:54المجموعة التالية من
  144. 2:55السجلات. فهي تتتبع
  145. 2:56الصفحات بدقة حتى مع
  146. 2:58معدل تغيير مرتفع في
  147. 2:59البيانات. كلا النهجين
  148. 3:01يمنعان إغراق مستهلكي
  149. 3:02واجهة برمجة
  150. 3:03التطبيقات بجميع
  151. 3:04البيانات دفعة واحدة.
  152. 3:05هذا يعزز الأداء ويحسن
  153. 3:07تجربة المستخدم.
  154. 3:08النصيحة رقم خمسة هي
  155. 3:10استخدام سلاسل
  156. 3:10استعلام واضحة لفرز
  157. 3:11وتصفية بيانات واجهة
  158. 3:12برمجة التطبيقات. إذا
  159. 3:14أراد مستخدم الفرز حسب
  160. 3:15تاريخ التسجيل، أضف
  161. 3:16معامل فرز بسيط مثل "sort
  162. 3:18= registered". هل تحتاج فقط
  163. 3:19إلى المنتجات الزرقاء
  164. 3:20؟ جرب استخدام عامل
  165. 3:22التصفية "color = blue". ما
  166. 3:23هي الفوائد؟ أولاً،
  167. 3:24تجعل سلاسل الاستعلام
  168. 3:26بيانات الاستجابة
  169. 3:27سهلة الفهم. يرى
  170. 3:28المطور على الفور
  171. 3:29عوامل التصفية النشطة
  172. 3:30أو ترتيب الفرز المطبق
  173. 3:32. ثانياً، يسهل إضافة
  174. 3:33معايير فرز وتصفية
  175. 3:35إضافية بمرور الوقت
  176. 3:36دون كسر عمليات
  177. 3:37التكامل الحالية.
  178. 3:38ثالثاً، يمكن تخزين
  179. 3:39مجموعات النتائج
  180. 3:40المصفاة والمرتبة
  181. 3:41مؤقتًا بشكل منفصل
  182. 3:42لزيادة السرعة.
  183. 3:43النصيحة رقم ستة، لا
  184. 3:44تجعل الأمان فكرة
  185. 3:45ثانوية عند تصميم
  186. 3:46واجهات برمجة
  187. 3:47التطبيقات. بالنسبة
  188. 3:48للاعتمادات الحساسة
  189. 3:49مثل مفاتيح API، استفد
  190. 3:51من رؤوس HTTP بدلاً من
  191. 3:52عناوين URL. يتم تسجيل
  192. 3:53عناوين URL في سجل وصول
  193. 3:55الخادم، مما يكشف السر
  194. 3:56كنص عادي. الرؤوس مثل "
  195. 3:58Authorization" تقلل من هذا
  196. 3:59الخطر. لكن الرؤوس لا
  197. 4:01تزال قادرة على التسرب
  198. 4:02، لذا افرض تشفير TLS
  199. 4:03الكامل لجميع الحركات
  200. 4:04لحماية الإرسال من
  201. 4:05البداية للنهاية. نفذ
  202. 4:06ضوابط وصول قوية. تحقق
  203. 4:09من المفاتيح والرموز
  204. 4:10في كل طلب قبل
  205. 4:11المعالجة. الأمان
  206. 4:12موضوع عميق. لقد
  207. 4:14تطرقنا فقط إلى القشور
  208. 4:15. تأكد من مواكبة أحدث
  209. 4:17الممارسات الموصى بها.
  210. 4:18النصيحة رقم سبعة،
  211. 4:20اجعل المراجع بين
  212. 4:21الموارد بسيطة. استخدم
  213. 4:23روابط واضحة بين
  214. 4:24الموارد المتصلة. لا
  215. 4:25تزدحم الأمور بسلاسل
  216. 4:27استعلام طويلة. على
  217. 4:28سبيل المثال، أشر إلى
  218. 4:30العنصر 321 داخل العربة
  219. 4:32123 من خلال مسار نظيف
  220. 4:34كهذا. هذا يتجنب
  221. 4:35معاملات الاستعلام
  222. 4:36الفوضوية مثل التي
  223. 4:37نراها على الشاشة.
  224. 4:38المسارات المباشرة
  225. 4:39تجعل الارتباطات
  226. 4:40واضحة للمطور الذي
  227. 4:41يستخدم واجهة برمجة
  228. 4:42التطبيقات. النصيحة
  229. 4:44الأخيرة، خطط لتحديد
  230. 4:45معدل الطلبات. هذا
  231. 4:46يحمي واجهات برمجة
  232. 4:47التطبيقات من التحميل
  233. 4:48الزائد أو سوء
  234. 4:49الاستخدام. حدد حصص
  235. 4:50طلبات بناءً على أبعاد
  236. 4:51مثل عناوين IP المصدر،
  237. 4:53أو حسابات المستخدمين
  238. 4:54، أو فئات نقاط
  239. 4:55النهاية. على سبيل
  240. 4:56المثال، قد يحصل عملاء
  241. 4:58المستوى المجاني على
  242. 4:591000 طلب يوميًا، ويتم
  243. 5:00تحديد كل عنوان IP بـ 20
  244. 5:02مكالمة في الدقيقة.
  245. 5:03هذه الحصص لا تحمي
  246. 5:04البنية التحتية فحسب،
  247. 5:06بل تشجع الاستخدام
  248. 5:07العادل كجزء من عقد
  249. 5:08الخدمة عبر جميع
  250. 5:09العملاء. كما أنها
  251. 5:11تقلل من مساحة الهجوم
  252. 5:13من هجمات DDoS. تصميم
  253. 5:14واجهة برمجة
  254. 5:15التطبيقات لا يتعلق
  255. 5:16فقط بجعلها تعمل. بل
  256. 5:17يتعلق بجعلها تعمل
  257. 5:19بشكل جيد وآمن. من خلال
  258. 5:21مراعاة اتفاقيات REST
  259. 5:23وأفضل الممارسات التي
  260. 5:25ناقشناها، ستنشئ
  261. 5:26واجهات برمجة تطبيقات
  262. 5:28قوية وموثوقة وممتعة
  263. 5:30للمطورين. إذا أعجبتك
  264. 5:32فيديوهاتنا، فقد
  265. 5:33تعجبك نشرتنا
  266. 5:33الإخبارية حول تصميم
  267. 5:35الأنظمة أيضًا. إنها
  268. 5:36تغطي مواضيع واتجاهات
  269. 5:38في تصميم الأنظمة
  270. 5:39واسعة النطاق، ويثق
  271. 5:40بها 500,000 قارئ. اشترك
  272. 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.