فلش‌کارت‌های آموزشی معماری نرم‌افزار: API Design Best Practices

🎓 دوره آموزشی جامع

📚 اطلاعات دوره

عنوان دوره: دوره معماری نرم‌افزار: API Design Best Practices

موضوع کلی: برنامه نویسی

موضوع میانی: معماری نرم‌افزار

📋 سرفصل‌های دوره

• 1. API چیست؟ مقدمه‌ای بر رابط‌های برنامه‌نویسی کاربردی
• 2. چرا طراحی API اهمیت دارد؟ نقش آن در معماری نرم‌افزار
• 3. تاریخچه مختصر APIها: از RPC تا وب‌سرویس‌ها
• 4. انواع APIها: عمومی (Public)، خصوصی (Private) و شریک (Partner)
• 5. آشنایی با سبک‌های معماری API: REST، SOAP، GraphQL و gRPC
• 6. مفاهیم کلیدی HTTP برای طراحان API: درخواست و پاسخ
• 7. تشریح یک درخواست HTTP: متدها، هدرها، بدنه
• 8. تشریح یک پاسخ HTTP: کدهای وضعیت، هدرها، بدنه
• 9. رویکرد طراحی API-First چیست و چرا مهم است؟
• 10. قرارداد API (API Contract): تعریف و اهمیت آن
• 11. تجربه توسعه‌دهنده (Developer Experience) در طراحی API
• 12. اصول یک طراحی API خوب: سادگی، پایداری و انعطاف‌پذیری
• 13. مروری بر مدل کلاینت-سرور و نقش API
• 14. اصل بی‌حالتی (Statelessness) در معماری API
• 15. مفهوم رابط یکپارچه (Uniform Interface)
• 16. REST چیست؟ مروری بر محدودیت‌های معماری
• 17. منابع (Resources) به جای اقدامات (Actions): تفکر مبتنی بر موجودیت
• 18. قواعد نام‌گذاری URI: استفاده از اسم‌های جمع
• 19. تفاوت پارامترهای مسیر (Path) و پارامترهای پرس‌وجو (Query)
• 20. استفاده صحیح از متدهای HTTP: GET، POST، PUT، DELETE
• 21. تفاوت PUT و PATCH: به‌روزرسانی کامل در مقابل جزئی
• 22. متدهای امن (Safe) و خودتوان (Idempotent)
• 23. کدهای وضعیت HTTP: گروه 2xx (موفقیت‌آمیز)
• 24. کاربرد دقیق کدهای 200 (OK)، 201 (Created) و 204 (No Content)
• 25. کدهای وضعیت HTTP: گروه 3xx (تغییر مسیر)
• 26. کدهای وضعیت HTTP: گروه 4xx (خطاهای کلاینت)
• 27. تفاوت 400 (Bad Request)، 401 (Unauthorized) و 403 (Forbidden)
• 28. کاربرد کدهای 404 (Not Found) و 405 (Method Not Allowed)
• 29. مدیریت درخواست‌های بیش از حد با کد 429 (Too Many Requests)
• 30. کدهای وضعیت HTTP: گروه 5xx (خطاهای سرور)
• 31. طراحی روابط: منابع تو در تو (Nested Resources)
• 32. طراحی روابط: استفاده از پارامترهای پرس‌وجو برای ارتباط
• 33. مذاکره محتوا (Content Negotiation): پشتیبانی از فرمت‌های مختلف
• 34. استفاده مؤثر از هدرهای HTTP
• 35. طراحی منابع مجموعه (Collection Resources)
• 36. طراحی منابع تکی (Singleton Resources)
• 37. بهترین شیوه‌ها در طراحی URI
• 38. مدیریت عملیات پیچیده: چه زمانی از فعل در URI استفاده کنیم؟
• 39. مفهوم و پیکربندی CORS (Cross-Origin Resource Sharing)
• 40. JSON به عنوان استاندارد تبادل داده در APIهای مدرن
• 41. قواعد نام‌گذاری در Payload: camelCase در مقابل snake_case
• 42. طراحی پاسخ‌های خطا: ساختار استاندارد برای پیام‌های خطا
• 43. راهبردهای صفحه‌بندی (Pagination): مبتنی بر Offset
• 44. راهبردهای صفحه‌بندی: مبتنی بر Cursor (Keyset)
• 45. طراحی قابلیت فیلتر کردن (Filtering) در مجموعه‌ها
• 46. طراحی قابلیت مرتب‌سازی (Sorting)
• 47. انتخاب فیلدهای خاص (Sparse Fieldsets) برای بهینه‌سازی پاسخ
• 48. جاسازی منابع مرتبط (Embedding) در پاسخ
• 49. مفهوم HATEOAS و APIهای قابل کشف (Discoverable)
• 50. پیاده‌سازی HATEOAS: افزودن لینک‌های مرتبط به پاسخ‌ها
• 51. نحوه مدیریت مقادیر null و خالی در پاسخ‌ها
• 52. اهمیت ثبات در نوع داده‌ها (Data Types)
• 53. استفاده از پوشش (Envelope) برای فراداده در پاسخ
• 54. بین‌المللی‌سازی (i18n) و محلی‌سازی (L10n) در API
• 55. مبانی امنیت API: تهدیدات رایج
• 56. تفاوت احراز هویت (Authentication) و مجوزدهی (Authorization)
• 57. راهبردهای احراز هویت: کلیدهای API (API Keys)
• 58. راهبردهای احراز هویت: Basic Auth و معایب آن
• 59. مقدمه‌ای بر OAuth 2.0
• 60. آشنایی با Grant Type‌های مختلف در OAuth 2.0
• 61. آشنایی با OpenID Connect (OIDC) برای احراز هویت
• 62. کاربرد توکن‌های وب JSON (JWT)
• 63. اهمیت استفاده از HTTPS/TLS برای رمزنگاری ارتباط
• 64. اعتبارسنجی و پاک‌سازی ورودی‌ها برای جلوگیری از حملات
• 65. مروری بر لیست OWASP API Security Top 10
• 66. کنترل دسترسی مبتنی بر نقش (RBAC) در API
• 67. راهبردهای نسخه‌بندی (Versioning): از طریق مسیر URI
• 68. راهبردهای نسخه‌بندی: از طریق هدر سفارشی
• 69. راهبردهای نسخه‌بندی: از طریق پارامتر پرس‌وجو
• 70. سازگاری رو به عقب (Backward Compatibility) و تغییرات شکننده
• 71. پیاده‌سازی عملی خودتوانی (Idempotency) برای درخواست‌های ناپایدار
• 72. محدودسازی نرخ درخواست (Rate Limiting) و Throttling
• 73. راهبردهای کشینگ (Caching) برای بهبود عملکرد API
• 74. استفاده از ETag برای درخواست‌های شرطی
• 75. عملیات ناهمگام (Asynchronous) و وب‌هوک‌ها (Webhooks)
• 76. اصول طراحی وب‌هوک‌های قابل اعتماد
• 77. طراحی عملیات دسته‌ای (Bulk Operations)
• 78. الگوی API Gateway و کاربردهای آن
• 79. طراحی API در معماری میکروسرویس
• 80. الگوی Backend for Frontend (BFF)
• 81. ترکیب APIها (API Composition)
• 82. قابلیت مشاهده‌پذیری (Observability) در API: لاگ‌برداری
• 83. قابلیت مشاهده‌پذیری: معیارهای کلیدی (Metrics)
• 84. قابلیت مشاهده‌پذیری: ردیابی توزیع‌شده (Distributed Tracing)
• 85. چرا مستندسازی API حیاتی است؟
• 86. آشنایی با مشخصات OpenAPI (Swagger)
• 87. نوشتن مستندات مؤثر با استفاده از OpenAPI
• 88. ابزارهای تولید مستندات: Swagger UI, Redoc, Postman
• 89. شبیه‌سازی (Mocking) و مجازی‌سازی API
• 90. راهبردهای تست API: تست واحد، یکپارچه‌سازی و End-to-End
• 91. خودکارسازی تست‌های API
• 92. چرخه حیات API: از طراحی تا منسوخ شدن
• 93. راهبردهای منسوخ کردن (Deprecation) یک API
• 94. جمع‌آوری بازخورد و تکرار در طراحی API
• 95. مقدمه‌ای بر GraphQL: چه زمانی از آن استفاده کنیم؟
• 96. مفاهیم کلیدی GraphQL: اسکما، کوئری‌ها و جهش‌ها
• 97. مقدمه‌ای بر gRPC: کارایی بالا با Protocol Buffers
• 98. مقدمه‌ای بر WebSockets برای ارتباطات دوطرفه و آنی
• 99. انتخاب پارادایم مناسب API برای نیازهای مختلف
• 100. امنیت API: احراز هویت، مجوزدهی و حفاظت در برابر تهدیدها**