فلش‌کارت‌های آموزشی معماری نرم‌افزار: مستندسازی API با استفاده از OpenAPI (Swagger)

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

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

عنوان دوره: دوره معماری نرم‌افزار: مستندسازی API با استفاده از OpenAPI (Swagger)

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

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

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

• 1. مقدمه‌ای بر معماری نرم‌افزار و نقش API‌ها
• 2. API چیست و چرا مستندسازی آن حیاتی است؟
• 3. چالش‌های مستندسازی سنتی API
• 4. معرفی OpenAPI Specification (OAS)
• 5. تاریخچه OpenAPI: از Swagger تا OAS 3.x
• 6. تفاوت بین OpenAPI و Swagger
• 7. مزایای استفاده از رویکرد Design-First در طراحی API
• 8. مزایای استفاده از رویکرد Code-First در طراحی API
• 9. آشنایی با فرمت‌های YAML و JSON برای تعریف مشخصات
• 10. مقایسه YAML و JSON: کدام یک برای OpenAPI مناسب‌تر است؟
• 11. نصب و راه‌اندازی ابزارهای اولیه (مانند Swagger Editor)
• 12. ساختار کلی یک سند OpenAPI 3.0
• 13. معرفی شیء `info`: متادیتای API
• 14. تعریف عنوان، توضیحات و نسخه API
• 15. اطلاعات تماس و لایسنس در شیء `info`
• 16. معرفی شیء `servers`: تعریف محیط‌های مختلف (توسعه، تست، پروداکشن)
• 17. استفاده از متغیرها در URL سرورها
• 18. معرفی شیء `tags`: دسته‌بندی عملیات‌ها
• 19. معرفی شیء `paths` و ساختار آن
• 20. معرفی شیء `components`: تعریف اجزای قابل استفاده مجدد
• 21. مفهوم و اهمیت Reusability در OpenAPI
• 22. معرفی `externalDocs`: پیوند به مستندات خارجی
• 23. ساختار پایه یک Path Item Object
• 24. تعریف Operation Object برای متدهای HTTP
• 25. تعریف یک عملیات ساده GET
• 26. افزودن `summary` و `description` برای عملیات‌ها
• 27. استفاده از `operationId` و بهترین شیوه‌ها
• 28. علامت‌گذاری عملیات‌ها به عنوان `deprecated`
• 29. معرفی انواع پارامترها: Path, Query, Header, Cookie
• 30. تعریف پارامترهای مسیر (Path Parameters)
• 31. الزامی کردن پارامترها با فیلد `required`
• 32. تعریف پارامترهای کوئری (Query Parameters)
• 33. تعریف پارامترهای هدر (Header Parameters)
• 34. تعریف پارامترهای کوکی (Cookie Parameters)
• 35. معرفی شیء `requestBody`: تعریف بدنه درخواست
• 36. تفاوت `requestBody` و پارامترهای `formData` در OAS 2
• 37. تعریف محتوای `requestBody` برای انواع مختلف Media Type
• 38. ارسال فایل‌ها (File Upload) با `multipart/form-data`
• 39. تعریف `requestBody` به صورت `required`
• 40. معرفی شیء `responses`: تعریف پاسخ‌های ممکن
• 41. تعریف یک پاسخ موفق (کدهای 2xx)
• 42. تعریف پاسخ‌های خطا (کدهای 4xx و 5xx)
• 43. استفاده از کدهای وضعیت HTTP به عنوان کلید در `responses`
• 44. تعریف `description` برای هر پاسخ
• 45. تعریف هدرها در پاسخ (Response Headers)
• 46. تعریف محتوای پاسخ (Response Body)
• 47. استفاده از `default` برای پاسخ‌های پیش‌فرض
• 48. مفهوم `callbacks`: تعریف وب‌هوک‌ها و API‌های ناهمزمان
• 49. تعریف یک مثال ساده از `callbacks`
• 50. معرفی `links`: بیان روابط بین پاسخ‌ها و عملیات‌ها
• 51. معرفی شیء `schema` برای تعریف مدل‌های داده
• 52. انواع داده‌های اولیه (Primitive Data Types): string, number, integer, boolean
• 53. تعریف فرمت‌های خاص برای داده‌ها (date, date-time, email, uuid)
• 54. تعریف اشیاء (Objects) و خصوصیات (properties) آنها
• 55. تعریف آرایه‌ها (Arrays) و آیتم‌های درون آن
• 56. ساخت مدل‌های داده تو در تو (Nested Objects and Arrays)
• 57. استفاده از `example` و `examples` برای نمایش داده‌های نمونه
• 58. اعتبارسنجی (Validation): محدودیت‌های طول برای رشته‌ها (`minLength`, `maxLength`)
• 59. اعتبارسنجی (Validation): استفاده از الگوهای عبارات باقاعده (`pattern`)
• 60. اعتبارسنجی (Validation): محدودیت‌های عددی (`minimum`, `maximum`)
• 61. اعتبارسنجی (Validation): محدودیت‌های آرایه (`minItems`, `maxItems`, `uniqueItems`)
• 62. تعریف مقادیر شمارشی (Enums)
• 63. تعریف مقادیر پیش‌فرض (Default Values)
• 64. مدیریت مقادیر `null`
• 65. استفاده از `readOnly` و `writeOnly` برای فیلدها
• 66. ترکیب Schemaها: `allOf` برای ارث‌بری و ترکیب
• 67. ترکیب Schemaها: `oneOf` برای انتخاب یکی از چند مدل
• 68. ترکیب Schemaها: `anyOf` برای انتخاب یک یا چند مدل
• 69. مفهوم `discriminator` برای مدل‌سازی چندریختی (Polymorphism)
• 70. تعریف Schemaهای قابل استفاده مجدد در بخش `components/schemas`
• 71. ارجاع به Schemaهای مشترک با استفاده از `$ref`
• 72. مستندسازی امنیت API: معرفی `securitySchemes`
• 73. تعریف احراز هویت با API Key
• 74. تعریف احراز هویت با HTTP (Basic, Bearer)
• 75. تعریف احراز هویت با OAuth 2.0
• 76. تعریف احراز هویت با OpenID Connect
• 77. اعمال نیازمندی‌های امنیتی (`security`) به کل API یا عملیات‌های خاص
• 78. نسخه‌بندی (Versioning) API و بازتاب آن در مستندات OpenAPI
• 79. استراتژی‌های نسخه‌بندی: در URL، در هدر و ...
• 80. استفاده از افزونه‌ها (Specification Extensions) با پیشوند `x-`
• 81. تعریف مثال‌های قابل استفاده مجدد در `components/examples`
• 82. تعریف پارامترهای قابل استفاده مجدد در `components/parameters`
• 83. تعریف هدرهای قابل استفاده مجدد در `components/headers`
• 84. تعریف بدنه‌های درخواست قابل استفاده مجدد در `components/requestBodies`
• 85. تعریف پاسخ‌های قابل استفاده مجدد در `components/responses`
• 86. معرفی ابزارهای اکوسیستم Swagger/OpenAPI
• 87. کار با Swagger Editor: ویرایش و اعتبارسنجی آنلاین
• 88. کار با Swagger UI: تولید مستندات تعاملی و زیبا
• 89. شخصی‌سازی ظاهر Swagger UI
• 90. معرفی Swagger Codegen: تولید خودکار کدهای Client و Server
• 91. استفاده از Swagger Codegen برای تولید SDK کلاینت (مثلاً جاوااسکریپت)
• 92. استفاده از Swagger Codegen برای تولید اسکلت سرور (مثلاً Spring Boot)
• 93. یکپارچه‌سازی OpenAPI با فریمورک‌های Code-First: Springdoc در جاوا
• 94. یکپارچه‌سازی OpenAPI با فریمورک‌های Code-First: Swashbuckle در ASP.NET Core
• 95. یکپارچه‌سازی OpenAPI با فریمورک‌های Code-First: FastAPI در پایتون
• 96. استفاده از ابزارهای Linting برای بررسی کیفیت و ثبات سند OpenAPI
• 97. اتوماسیون فرآیند مستندسازی در CI/CD
• 98. بهترین شیوه‌ها در نام‌گذاری مسیرها و پارامترها
• 99. بهترین شیوه‌ها در نوشتن توضیحات (Descriptions) واضح و کاربردی
• 100. استراتژی‌های نگهداری و به‌روزرسانی مستندات OpenAPI