آموزش ساختن Web API در ASP.NET Core – برترین روش ها یکی دیگر از آموزش های گروه آموزشی پرووید می باشد که در این قسمت آن را به شما معرفی می کنیم. این بسته آموزشی نیز یکی از دوره های آموزشی دیگر که در حوزه فارسی سازی آموزش های انگلیسی تنظیم شده است می باشد. عنوان این بسته آموزشی، آموزش برترین روش های ساختن Web API در ASP.NET Core است که با نام اصلی ASP.NET Core 6 Web API – Best Practices از شرکت Pluralsight منتشر شده است.

Web API چیست؟

اولین سوالی که ممکن است در ذهن شما پیش بیاید این است که مفهوم یک Web API چیست؟ احتمالاً می دانید که کلمه API مخفف Application Programming Interface و یا واسط برنامه نویسی نرم افزار کاربردی است. به عبارت دیگر یک API نقش یک نرم افزار واسط و یا میانی را ایفا می کند که اجازه می دهد دو، یا چندین اپلیکیشن مختلف با یکدیگر ارتباط برقرار کنند. یکی از مهمترین مزایای استفاده کردن از API ها در برقراری ارتباط بین دو اپلیکیشن در این است که با ایجاد تغییر در جزئیات درونی هر کدام از اپلیکیشن ها هیچ اختلالی در ارتباط بین آنها اتفاق نمی افتد. البته این موضوع تا زمانی برقرار است که API آنها تغییر نکند. به عبارت دیگر اپلیکیشن ها با یک واسط می توانند با یکدیگر ارتباط برقرار کنند و از جزئیات درونی یکدیگر کاملاً بی اطلاع باشند.

ایجاد کردن یک API در ASP.NET Core

پس از بررسی کردن پاسخ سوال: یک API ممکن است سوال بعدی این باشد که یک Web API چیست؟ به بیان ساده می توان گفت که یک Web API یک Application Programming Interface برای web application ها یا web server ها می باشند. در واقع Web API ها از پروتکل HTTP به منظور برقراری ارتباط بین کلاینت ها و سرور ها استفاده می کنند. Web API ها را می توان با تکنولوژی های مختلف از قبیل ASP.NET Core که به صورت cross-platform پیاده سازی شده است، ایجاد نمود.

چرا به Web API نیاز داریم؟

دلایل مختلفی برای استفاده کردن از Web API وجود دارد. برای مثال فرض کنید که کاربر می خواهد از دستگاه های مختلف از قبیل موبایل، کامپیوتر و یا غیره به داده های موجود و صفحات درون سرور دسترسی پیدا کند. در چنین شرایطی، استفاده کردن از Web API بسیار مناسب خواهد بود. دستگاه ها و یا device های مختلف به سادگی request های خود را به Web API ارسال کرده و Web API پاسخ خود را اغلب با فرمت JSON برمی گرداند. بسیاری از device ها نیز قابلیت فهمیدن و درک کردن داده های JSON را دارند.

معماری REST چیست؟

سبک معماری REST در Web API ها مورد استفاده قرار می گیرد. به Web API هایی که با این سبک معماری نوشته می شوند اصطلاحاً restful API نامیده می گردند. کلمه REST، کوتاه شده REpresentational State Transfer است. این سبک معماری استانداردهایی را بین سیستم های کامپیوتری موجود بر روی وب برقرار می کند تا آنها بتوانند ساده تر با یکدیگر ارتباط برقرار کنند. سبک معماری REST براساس ارتباط بین کلاینت و سرور کار می کند. این اساساً بدان معناست که client application و server application بایستی بتوانند مستقل از یکدیگر و به صورت کاملاً تفکیک شده تکامل پیدا کنند. سبک معماری REST کاملاً stateless و یا بدون state می باشد. این بدان معناست که ارتباط بین کلاینت و سرور همواره شامل تمامی اطلاعات مورد نیاز برای پردازش کردن request فعلی است. به عبارت دیگر هیچ session state خاصی بر روی سرور ذخیره نمی شود و سرور می تواند بدون نیاز به هیچگونه داده اضافی هر کدام از request ها را پردازش کند. سبک معماری REST لزوماً به HTTP وابسته نیست. اما استفاده کردن از HTTP در سبک معماری REST، بسیار مرسوم است. در سبک معماری REST و HTTP، از verb های مختلفی به منظور ارسال request ها به سرور استفاده می شود. ساده ترین این verb ها شامل Get و Post و Put و Delete می باشند که به ترتیب به منظور دریافت یک resource و یا یک کالکشن از resource ها از سرور، ارسال کردن یک resource جدید به سرور، بروز رسانی کردن resource با استفاده از ID آن و حذف کردن یک resource با استفاده از ID آن می باشند.

سرفصل مطالب آموزش ویدئویی ساختن Web API در ASP.NET Core – برترین روش ها

فصل اول: مقدمه دوره آموزشی

• مقدمه دوره آموزشی

فصل دوم: چرا Best Practice ها اهمیت دارند؟

• مقدمه
• بررسی ورژن های مربوط به ابزارهای مورد استفاده در این دوره آموزشی
• چرا Best Practice ها اهمیت دارند؟
• مزایای یادگیری Best Practice ها
• بررسی اجمالی این دوره آموزشی

فصل سوم: بررسی Best Practice های مربوط به طراحی Web API ها

• مقدمه
• معرفی REST و ماهیت Resource ها
• طراحی API ها به همراه HTTP Verb ها
• آموزش عملی: کار کردن با HTTP Method ها و Resource ها
• طراحی API ها به همراه HTTP Status Code ها
• آموزش عملی: کار کردن با HTTP Status Code ها
• استفاده کردن از Response Type های مناسب در ASP.NET Core
• آموزش عملی: کار کردن با Response Type های مناسب در ASP.NET Core
• جمع بندی

فصل چهارم: بررسی Best Practice های مربوط به طراحی Model در Web API

• مقدمه
• مباحث اولیه  در رابطه با Model در Web API
• اعمال کردن Postel’s Law
• چه داده هایی را یک Web API می بایست Return کند؟
• ویژگی های مربوط به Model های مناسب در Web API
• بررسی Antipattern ها و یا ضد الگوهای مربوط به Model ها در Web API
• جمع بندی

فصل پنجم: بررسی Best Practice های مربوط به پیاده سازی Web API ها در ASP.NET Core

• مقدمه
• بررسی Best Practice های مربوط به پیاده سازی Web API ها در ASP.NET Core در MVC
• استفاده کردن از MediatR به همراه ASP.NET Core Web API ها
• آموزش عملی: استفاده کردن از سرویس ها و MediatR در کنار Controller ها
• انتقال دادن Controller ها به Endpoint ها
• بررسی Best Practice های مربوط به Minimal API ها در ASP.NET Core
• آموزش عملی: سازماندهی کردن Endpoint های Minimal API ها
• اضافه کردن Background Service ها به Web API ها
• جمع بندی

فصل ششم: بررسی Best Practice های مربوط به امنیت و یا Security در Web API ها

• مقدمه
• ایجاد امنیت در Web API ها با استفاده از JWT ها
• آموزش عملی: ایمن سازی Web API های ASP.NET Core به همراه JWT
• استفاده کردن مناسب از JWT
• آموزش عملی: استفاده کردن از JWT و Refresh Token ها به منظور ایمن سازی Web API های ASP.NET Core
• روش های جایگزین Token ها
• پیاده سازی Authorization و Authentication در ASP.NET Core
• آموزش عملی: استفاده کردن از Imperative Security Policie ها
• پیکربندی کردن CORS و HTTPS
• جمع بندی

فصل هفتم: بررسی Best Practice های مربوط به تست کردن Web API های ASP.NET Core

• مقدمه
• راه اندازی کردن تست های مربوط به Web API ها
• آموزش عملی: کار کردن با WebApplicationFactory در ASP.NET Core و Integration Test ها
• انجام عملیات Seed کردن Test Data ها
• استفاده کردن از Helper ها به منظور بهبود دادن تست ها
• آموزش عملی: Refactor کردن Integration Test های Web API ها
• جمع بندی