فلش‌کارت‌های آموزشی معماری نرم‌افزار: The Art of designing APIs

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

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

عنوان دوره: دوره معماری نرم‌افزار: The Art of designing APIs

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

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

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

• 1. مقدمه‌ای بر APIها و نقش آن‌ها در دنیای نرم‌افزار
• 2. چرا طراحی API یک هنر است؟ اهمیت معماری API
• 3. تاریخچه مختصر APIها: از RPC تا وب‌سرویس‌های مدرن
• 4. انواع API: خصوصی، شریک و عمومی (Private, Partner, Public)
• 5. کالبدشکافی یک درخواست و پاسخ HTTP
• 6. مفاهیم کلیدی: کلاینت، سرور و منابع (Resources)
• 7. فلسفه طراحی API-First و مزایای آن
• 8. تفاوت API و وب‌سرویس: شفاف‌سازی مفاهیم
• 9. مروری بر سبک‌های مختلف معماری API: REST, GraphQL, gRPC
• 10. معرفی معماری REST: اصول و محدودیت‌ها
• 11. اصل اول REST: معماری کلاینت-سرور
• 12. اصل دوم REST: بی‌حالتی (Statelessness)
• 13. اصل سوم REST: قابلیت کش شدن (Cacheability)
• 14. اصل چهارم REST: سیستم لایه‌ای (Layered System)
• 15. اصل پنجم REST: رابط یکپارچه (Uniform Interface)
• 16. معرفی GraphQL: یک زبان کوئری برای APIها
• 17. معرفی gRPC: کارایی بالا با Protocol Buffers
• 18. معرفی WebSockets: ارتباط دوطرفه و Real-time
• 19. معرفی Webhooks: معماری مبتنی بر رویداد
• 20. چگونه سبک API مناسب را انتخاب کنیم؟ (REST vs GraphQL vs gRPC)
• 21. مدل‌سازی منابع (Resources): شناسایی و تعریف موجودیت‌ها
• 22. قواعد نام‌گذاری منابع: استفاده از اسامی جمع و خوانا
• 23. اصول طراحی URI: سادگی و قابلیت پیش‌بینی
• 24. مدیریت روابط بین منابع: URIهای تودرتو در مقابل روابط سطح بالا
• 25. استفاده صحیح از متدهای HTTP: GET, POST, PUT, DELETE
• 26. مفهوم Idempotency و اهمیت آن در متدهای HTTP
• 27. متدهای امن (Safe Methods) و تفاوت آن‌ها
• 28. استفاده از PATCH برای به‌روزرسانی‌های جزئی
• 29. استفاده از متدهای HEAD و OPTIONS
• 30. هدرهای HTTP: فراداده‌های API شما
• 31. مذاکره محتوا (Content Negotiation) با هدرهای Accept و Content-Type
• 32. درک عمیق کدهای وضعیت HTTP
• 33. کدهای وضعیت موفقیت (2xx) و کاربردهای آن‌ها
• 34. کدهای وضعیت تغییر مسیر (3xx)
• 35. کدهای وضعیت خطای کلاینت (4xx): از 400 تا 429
• 36. کدهای وضعیت خطای سرور (5xx)
• 37. طراحی پیام‌های خطای معنادار و کاربردی برای توسعه‌دهندگان
• 38. معرفی HATEOAS: قدرت لینک‌ها در API
• 39. پیاده‌سازی عملی HATEOAS برای کشف‌پذیری API
• 40. استفاده موثر از پارامترهای کوئری (Query Parameters)
• 41. انتخاب فرمت داده: JSON به عنوان استاندارد دوفاکتو
• 42. بهترین شیوه‌ها در طراحی ساختار JSON
• 43. ثبات در نام‌گذاری فیلدها (camelCase, snake_case)
• 44. مدیریت مقادیر null و خالی در پاسخ‌ها
• 45. طراحی برای خوانایی در مقابل پرحرفی (Verbosity)
• 46. استراتژی‌های صفحه‌بندی (Pagination): Offset-based
• 47. استراتژی‌های صفحه‌بندی (Pagination): Cursor-based
• 48. فیلتر کردن و جستجو در مجموعه‌ها
• 49. مرتب‌سازی نتایج (Sorting)
• 50. پاسخ‌های جزئی: انتخاب فیلدهای مورد نیاز (Field Selection)
• 51. جاسازی منابع مرتبط (Embedding) در پاسخ‌ها
• 52. مروری بر استراتژی‌های نسخه‌بندی (Versioning) API
• 53. نسخه‌بندی از طریق URI (مانند /v1/)
• 54. نسخه‌بندی از طریق هدر سفارشی یا هدر Accept
• 55. مدیریت تغییرات شکننده (Breaking Changes) در API
• 56. مبانی امنیت API: CIA Triad
• 57. تفاوت احراز هویت (Authentication) و مجوزدهی (Authorization)
• 58. ایمن‌سازی API با HTTPS/TLS: چرا همیشه ضروری است؟
• 59. احراز هویت با کلیدهای API (API Keys)
• 60. آشنایی با OAuth 2.0: استاندارد مجوزدهی
• 61. آشنایی با جریان‌های مختلف OAuth 2.0
• 62. استفاده از OpenID Connect (OIDC) برای احراز هویت
• 63. توکن‌های وب جیسون (JWT): ساختار و کاربرد
• 64. بهترین شیوه‌های امنیتی برای کار با JWT
• 65. مدیریت CORS (Cross-Origin Resource Sharing)
• 66. اعتبارسنجی ورودی‌ها برای جلوگیری از حملات رایج
• 67. معرفی ۱۰ تهدید امنیتی برتر APIها از دید OWASP
• 68. محدودسازی نرخ درخواست‌ها (Rate Limiting)
• 69. استراتژی‌های پیاده‌سازی Rate Limiting و Throttling
• 70. مدیریت اطلاعات محرمانه (Secrets Management)
• 71. اهمیت کارایی و مقیاس‌پذیری در طراحی API
• 72. استراتژی‌های کشینگ API: سمت کلاینت، سرور و پراکسی
• 73. استفاده از هدرهای ETag و Last-Modified برای کشینگ بهینه
• 74. فشرده‌سازی پاسخ‌ها (مانند Gzip)
• 75. الگوی API Gateway: نقطه ورود یکتا
• 76. نقش API Gateway در امنیت، مانیتورینگ و Rate Limiting
• 77. توزیع بار (Load Balancing) برای مقیاس‌پذیری API
• 78. طراحی برای تحمل خطا: الگوهای Timeout و Retry
• 79. الگوی Circuit Breaker برای جلوگیری از خطاهای آبشاری
• 80. مدیریت عملیات طولانی (Long-running operations) با پاسخ 202 Accepted
• 81. طراحی اندپوینت‌های بررسی سلامت (Health Check)
• 82. مانیتورینگ و لاگینگ API: چه چیزهایی را باید ثبت کنیم؟
• 83. اهمیت تجربه توسعه‌دهنده (Developer Experience - DX)
• 84. بهترین شیوه‌ها در مستندسازی API
• 85. معرفی استاندارد OpenAPI (Swagger سابق)
• 86. نوشتن مستندات API با فرمت OpenAPI/Swagger
• 87. تولید مستندات تعاملی با ابزارهایی مانند Swagger UI و Redoc
• 88. ارائه SDK و کتابخانه‌های کلاینت برای زبان‌های مختلف
• 89. محیط‌های تست (Sandbox) و سرورهای Mock برای توسعه‌دهندگان
• 90. اطلاع‌رسانی تغییرات: Changelog و یادداشت‌های انتشار
• 91. نگاهی عمیق‌تر به GraphQL: اسکیما، کوئری‌ها و جهش‌ها (Mutations)
• 92. نگاهی عمیق‌تر به gRPC: تعریف سرویس با Protocol Buffers
• 93. طراحی API در معماری میکروسرویس: چالش‌ها و راهکارها
• 94. APIهای رویدادمحور با ابزارهایی مانند Kafka یا RabbitMQ
• 95. API Governance: ایجاد استاندارد و ثبات در سازمان
• 96. مدل‌های کسب درآمد از API (API Monetization)
• 97. چرخه حیات API: از طراحی و توسعه تا منسوخ شدن (Deprecation)
• 98. استراتژی‌های منسوخ کردن نسخه‌های قدیمی API
• 99. آینده APIها: هوش مصنوعی، اینترنت اشیاء و فراتر از آن
• 100. جمع‌بندی دوره و راهنمای پروژه نهایی: طراحی یک API کامل