بوت‌کمپ مهندسی بک‌اند با NestJS
آموزش جامع Swagger از صفر تا صد | پروژه‌محور

دوره آموزشی تخصصی

آموزش جامع Swagger از صفر تا صد | پروژه‌محور

۵۴۸ دانشجو
13 ویدیو
تکمیل شده

مدت دوره

114 دقیقه

تعداد ویدیوها

13 ویدیو

دانشجویان

548 نفر

سطح

پیشرفته

تاریخ انتشار

1 آذر 1404

آخرین بروزرسانی

1 آذر 1404

توی دوره جامع Swagger | مقدماتی تا پیشرفته پروژه‌محور قرار نیست فقط چند تا دکمه رو توی پنل Swagger فشار بدی و بری کنار! این دوره طوری طراحی شده که از همون قدم اول، بفهمی Swagger دقیقاً چیه، چرا تو هر تیم حرفه‌ای جزو واجب‌های دنیاست، و چطور می‌تونه زندگی خودت و تیم فرانت و تست و محصول رو خیلی راحت‌تر کنه.

ما از صفرِ صفر شروع می‌کنیم؛ از اینکه Swagger و OpenAPI چی هستن و کجا به درد می‌خورن، تا راه‌اندازی تو پروژه واقعی، نوشتن داکیومنت تمیز برای endpointها، تعریف مدل‌ها، ورودی‌ها، خروجی‌ها، خطاها، نسخه‌بندی API و حتی آماده کردن یه مستندات شیک که روش بشه برای تیم و مدیر و مشتری مانور رفت! 😄

این دوره کاملاً پروژه‌محوره؛ یعنی به‌جای حرف‌های تئوری و اسلایدهای خسته‌کننده، روی یه پروژه واقعی API کار می‌کنیم. قدم‌به‌قدم جلو می‌ریم، هر چیزی که یاد می‌گیری همون‌جا روی پروژه اجرا می‌کنی و نتیجه‌اش رو تو Swagger UI می‌بینی.

توی این دوره به‌صورت مرتب و مرحله‌ای این چیزها رو یاد می‌گیری:

آشنایی با Swagger، OpenAPI و مفاهیم پایه‌ای مستندسازی API

نصب و راه‌اندازی Swagger توی پروژه واقعی (Backend محور)

تعریف endpointها، پارامترها، body، header و انواع ریسپانس‌ها

مستندسازی خطاها و استثناها به‌شکل استاندارد

تعریف مدل‌های پیچیده، nested objectها و لیست‌ها

کار با نسخه‌بندی API (API Versioning) و مدیریت تغییرات

آماده کردن مستندات قابل فهم برای تیم فرانت‌اند، QA و بیزنس

تولید Client/SDK از روی مستندات برای زبان‌ها و فریم‌ورک‌های مختلف

نکات ریز اما مهمی که فقط وسط پروژه‌های واقعی باهاشون برخورد می‌کنی

این دوره برای کی مناسبه؟

دولوپرهای بک‌اند که می‌خوان APIهاشون تمیز، قابل فهم و حرفه‌ای باشه

تیم‌هایی که از قبل API دارن، ولی مستنداتشون هرج‌ومرجِ محضه

کسایی که می‌خوان تو رزومه‌شون با افتخار بنویسن: «تسلط به Swagger و OpenAPI»

هر کسی که از سوال‌های تکراری فرانت‌اند و تسترها خسته شده و می‌خواد همه‌چیز یه‌جا و مرتب باشه

در پایان دوره، یه نفر هستی که وقتی صحبت از مستندسازی API می‌شه، دیگه نمی‌ترسه! می‌دونی چطور از Swagger به‌عنوان یه ابزار حرفه‌ای برای مستندسازی، تست، هماهنگی تیمی و حتی مذاکره با بیزنس استفاده کنی. خلاصه، بعد از این دوره، APIهات فقط کار نمی‌کنن؛ درست و حسابی مستند و قابل ارائه‌ان.

آنچه خواهید آموخت

مستندسازی کامل و استاندارد APIها با Swagger و OpenAPI
تعریف endpointها، پارامترها، مدل‌ها و خطاها به‌صورت شفاف و تمیز
راه‌اندازی و تنظیم Swagger UI روی پروژه واقعی بک‌اند
نسخه‌بندی (Versioning) و مدیریت تغییرات در API
آماده‌کردن مستندات قابل فهم برای تیم فرانت‌اند، QA و بیزنس
استفاده از Swagger برای تست API و هماهنگی راحت‌تر داخل تیم
اضافه‌کردن Swagger به پروژه‌های موجود و مرتب‌کردن مستندات شلخته قبلی

محتوای دوره

2 فصل • 13 قسمت • 114 دقیقه

قسمت یکممقدمه و معرفی Swagger و OpenAPI | آشنایی با استاندارد طلایی مستندسازی APIدر این بخش با مفاهیم پایه‌ای Swagger و استاندارد OpenAPI آشنا می‌شین و می‌فهمین اصلاً چرا تقریبا همه تیم‌های حرفه‌ای برای مستندسازی API از این ابزارها استفاده می‌کنن.
رایگان۴ دقیقه
قسمت دومنصب و تنظیمات اولیه Swagger در NestJS | راه‌اندازی سریع مستندسازی APIدر این بخش یاد می‌گیرین چطور Swagger رو روی یک پروژه NestJS نصب و راه‌اندازی کنین و تنظیمات اولیه مستندسازی API رو انجام بدین. مرحله‌به‌مرحله از نصب پکیج‌های لازم شروع می‌کنیم، بعد سراغ کانفیگ SwaggerModule، ساخت داکیومنت اولیه، تنظیم عنوان، توضیحات، ورژن و URL مستندات می‌ریم و در نهایت یک پنل Swagger تمیز و قابل استفاده برای پروژه NestJS خواهید داشت.
رایگان۴ دقیقه

قسمت یکمبررسی کامل آپشن‌های Swagger در NestJS توی این قسمت تمام آپشن‌ها و تنظیمات مهم Swagger رو مرور می‌کنیم؛ از تنظیم عنوان و توضیحات گرفته تا ورژن، امنیت، فیلترها و شخصی‌سازی ظاهر پنل. هدف اینه بعد از این بخش بدونین برای هر پروژه چطور Swagger رو دقیق و حرفه‌ای کانفیگ کنین.
۶ دقیقه
قسمت دومبخش دوم: کاربرد عملی آپشن‌های Swagger در NestJS | مثال‌های واقعی و تنظیمات پیشرفتهتوی این بخش دوم، آپشن‌های مهم Swagger رو با مثال‌های عملی روی یک پروژه NestJS پیاده می‌کنیم؛ از تنظیم نسخه و گروه‌بندی APIها تا اضافه‌کردن امنیت، تگ‌ها و شخصی‌سازی داکیومنت، تا دقیق ببینین هر تنظیم چه تأثیری روی مستندات نهایی می‌ذاره.
۸ دقیقه
قسمت سوممستندسازی اولین API با Swagger | از کد تا داکیومنت قابل استفادهتوی این بخش قدم‌به‌قدم اولین API رو با Swagger مستندسازی می‌کنیم؛ از تعریف ساده یک endpoint شروع می‌کنیم، ورودی و خروجی رو مشخص می‌کنیم و یاد می‌گیرین چطور فقط با چند Annotation ساده، یک داکیومنت تمیز و قابل فهم برای تیم فرانت‌اند و تست بسازین. این قسمت بهترین نقطه شروعه تا ببینین مستندسازی API با Swagger چقدر می‌تونه راحت و کاربردی باشه.
۸ دقیقه
قسمت چهارممستندسازی RESTful API با Swagger | طراحی تمیز، استاندارد و قابل فهمتوی این بخش یاد می‌گیرین چطور یک RESTful API واقعی رو با استفاده از Swagger به‌صورت استاندارد مستندسازی کنین. از تعریف مسیرها بر اساس متدهای HTTP مثل GET، POST، PUT و DELETE شروع می‌کنیم، بعد سراغ ورودی‌ها، خروجی‌ها، کدهای وضعیت (Status Code)، مدل داده و خطاها می‌ریم تا در نهایت یه داکیومنت مرتب، قابل فهم و کاملاً RESTful برای APIتون داشته باشین؛ چیزی که هم برای تیم فنی واضح باشه، هم برای بیزنس قابل ارائه.
۱۹ دقیقه
قسمت پنجمبررسی ApiProperty، DTO و Schema در Swagger | مستندسازی دقیق مدل‌های دادهتوی این بخش سراغ قلب مستندسازی می‌ریم: کار با @ApiProperty، ساخت DTOهای استاندارد و درک نقش Schema در Swagger. مرحله‌به‌مرحله می‌بینین چطور می‌شه برای هر فیلد توضیح، مثال، نوع داده، الزامی بودن (required) و… تعریف کرد تا خروجی Swagger‌تون دقیقاً همون چیزی باشه که توی کد هست. این قسمت کمک می‌کنه مدل‌های داده‌تون رو تمیز، قابل فهم و حرفه‌ای مستندسازی کنین، طوری که فرانت‌اند و QA بدون سؤال اضافه بتونن از روی داکیومنت کار کنن.
۶ دقیقه
قسمت ششمبررسی مشکل Circular Dependency در اینترفیس‌های جنریک TypeScript برای Swagger | حل خطاهای Loop در مدل‌هاتوی این بخش می‌ریم سراغ یکی از اعصاب‌خُردکن‌ترین باگ‌ها موقع مستندسازی: مشکل circular dependency وقتی از اینترفیس‌ها و جنریک‌ها تو TypeScript استفاده می‌کنیم و Swagger روی مدل‌ها گیر می‌کنه. مرحله‌به‌مرحله توضیح می‌دیم این حلقه‌های وابستگی چطور به‌وجود میان، چرا Swagger و OpenAPI نمی‌تونن به‌درستی Schema بسازن و چه الگوها و ترفندهایی برای دور زدن یا برطرف‌کردن این مشکل وجود داره
۷ دقیقه
قسمت هفتمکار با Enum در Swagger | مستندسازی مقادیر ثابت و قابل انتخاب در APIتوی این بخش یاد می‌گیرین چطور Enumها رو تو Swagger به‌درستی تعریف و مستندسازی کنین تا مقادیر ثابت مثل وضعیت سفارش، نقش کاربر، نوع پرداخت و… هم تو کد تمیز باشن، هم تو داکیومنت کاملاً شفاف نمایش داده بشن. با هم می‌بینیم چطور Enumهای TypeScript یا زبان بک‌اند رو به Swagger معرفی کنیم، مقادیر قابل انتخاب رو تو پنل Swagger UI نشون بدیم، و کاری کنیم فرانت‌اند و QA دقیق بدونن چه مقدارهایی مجاز هستن.
۱۰ دقیقه
قسمت هشتمکار با داده‌های تو در تو (Nested) در Swagger | مستندسازی مدل‌های پیچیده و چندلایهتوی این بخش سراغ مستندسازی داده‌های تو در تو یا همون Nested Data می‌ریم؛ جاهایی که مدل‌هامون فقط چند تا فیلد ساده نیستن و داخلشون آبجکت‌ها و لیست‌های چندلایه داریم. قدم‌به‌قدم نشون می‌دیم چطور DTOها و Schemaهای تو در تو رو تعریف کنین، رابطه بین مدل‌ها رو تو Swagger مشخص کنین و کاری کنین خروجی داکیومنت دقیقاً ساختار واقعی JSON رو منعکس کنه. بعد از این قسمت، حتی برای پیچیده‌ترین ریسپانس‌ها هم می‌تونین یه مستند تمیز و قابل فهم بسازین.
۸ دقیقه
قسمت نهمآپلود فایل در Swagger | مستندسازی و تست آپلود فایل در APIتوی این بخش یاد می‌گیرین چطور Endpointهای مربوط به آپلود فایل رو تو Swagger به‌درستی مستندسازی کنین؛ از تنظیم Content-Type مناسب (multipart/form-data) و تعریف فیلد فایل، تا اضافه‌کردن فیلدهای کمکی مثل عنوان، توضیحات یا نوع فایل. قدم‌به‌قدم نشون می‌دیم چطور امکان تست آپلود فایل رو مستقیم از داخل پنل Swagger UI فعال کنین تا تیم فرانت‌اند و QA بدون دردسر بتونن سناریوهای مختلف رو روی API امتحان کنن.
۱۰ دقیقه
قسمت دهمپیاده‌سازی Security در Swagger | مستندسازی احراز هویت و توکن در APIتوی این بخش می‌ریم سراغ بحث مهم امنیت در Swagger و یاد می‌گیرین چطور مکانیزم‌های احراز هویت مثل Bearer Token (JWT)، API Key یا Basic Auth رو تو مستندات API پیاده کنین. قدم‌به‌قدم تنظیمات securityScheme رو تعریف می‌کنیم، نحوه اضافه‌کردن Authorization به درخواست‌ها رو نشون می‌دیم و یاد می‌گیرین چطور فقط با چند کانفیگ ساده، کاری کنین همه endpointهای محافظت‌شده، تو Swagger هم به‌درستی نمایش داده بشن و هم قابل تست باشن. بعد از این قسمت، مستندات API شما فقط خوشگل نیست؛ امن و قابل اتکاست.
۸ دقیقه
قسمت یازدهمنکات تکمیلی در Swagger | ترفندها، ریزه‌کاری‌ها و تجربه‌های عملی مستندسازی API ( قسمت پایانی)توی این بخش سراغ نکات تکمیلی و ریزه‌کاری‌های Swagger می‌ریم؛ چیزهایی که شاید تو داکیومنت رسمی کم‌تر به چشم بیان ولی تو پروژه‌های واقعی کلی به درد می‌خورن. از بهینه‌کردن توضیحات و مثال‌ها (examples) گرفته تا گروه‌بندی بهتر endpointها، تمیز نگه‌داشتن مدل‌ها، مدیریت تغییرات، استاندارد نگه‌داشتن نام‌گذاری‌ها و استفاده از قابلیت‌هایی مثل deprecated، تگ‌ها و توضیحات سطح بالا. هدف این قسمت اینه که مستندات API شما فقط «کامل» نباشه، بلکه حرفه‌ای، خوانا و قابل استفاده تو تیم‌های شلوغ و پروژه‌های جدی باشه.
۱۶ دقیقه

سوالات متداول

نظرات و پرسش‌ها

رایگان

دوره‌های مرتبط

بوتکمپ مهندسی بک اند با NestJS
۹٬۰۰۰٬۰۰۰ تومان۵٬۰۰۰٬۰۰۰ تومانپیشرفته

بوتکمپ مهندسی بک اند با NestJS

یه نئوبانک مثل بلوبانک رو از صفر می‌سازیم و پشت هر تصمیم مهندسی می‌ایستیم: از حسابداری دوطرفه و کنترل همزمانی تا امضای دستگاه، تست و استقرار روی سرور واقعی.

۵۵ ویدیو
۲۰ ساعت
۳۱ نفر
دوره جامع معماری نرم‌افزار (Software Architecture)
۲٬۰۰۰٬۰۰۰ تومان۱٬۰۰۰٬۰۰۰ تومانپیشرفته

دوره جامع معماری نرم‌افزار (Software Architecture)

تو این دوره، مهم‌ترین معماری‌های نرم‌افزار رو از Clean و DDD تا میکروسرویس، خیلی خلاصه و کاربردی یاد می‌گیری.

۱۴ ویدیو
۴ ساعت
۱۶ نفر
دوره جامع فرانت اند | پیشرفته و پروژه محور
رایگانپیشرفته

دوره جامع فرانت اند | پیشرفته و پروژه محور

react رو با TypeScript، React Hook Form، React Query، Zustand و Tailwind تا لِوِل ارشد ببر همه‌چی کاملاً پروژه‌محور!

۵۶ ویدیو
۱۶ ساعت
۱۴۵۸ نفر
راهنماى برنامه نويسى و ديزاين بدون اينترنت
رایگانپیشرفته

راهنماى برنامه نويسى و ديزاين بدون اينترنت

راهنمای بقای چریک‌های دیجیتال در روزهایی که اینترنت خاطره می‌شود! یاد می‌گیریم چطور با ستاپ آفلاین و ابزارهای جایگزین، نگذاریم چرخ پروژه و دیزاین در بن‌بستِ قطعی شبکه از حرکت بیفتد.

۱۱ ویدیو
۲ ساعت
۵۶۸ نفر