آموزش ساختن RESTful API با OData V4 در ASP.NET Core یکی دیگر از آموزش های گروه آموزشی پرووید می باشد که در این قسمت آن را به شما معرفی می کنیم. این بسته ی آموزشی نیز یکی از دوره های آموزشی دیگر که در حوزه ی فارسی سازی آموزش های انگلیسی تنظیم شده است می باشد. عنوان این بسته ی آموزشی ساختن RESTful API های یک شکل با OData V4 در ASP.NET Core است که با نام اصلی Building a Consistent RESTful API with OData V4 in ASP.NET Core از شرکت Pluralsight منتشر شده است.

تکنولوژی OData

تکنولوژی OData یا همان Open Data Protocol که یک استاندارد OASIS است و بهترین روش را برای ایجاد و مصرف API های RESTful تعریف می کند. OData به شما کمک می کند تا هنگام ایجاد API های RESTful بر منطق کسب و کار خود تمرکز کنید بدون اینکه نگران رویکردهای تعریف response header ها و request ها و status code ها و HTTP method ها و URL conventions ها و media type ها و قالب های داده های بارگذاری شده و گزینه های پرس و جو باشید. تکنولوژی OData همچنین شما را در مورد تغییرات track ها و تعریف توابع و procedures های قابل استفاده مجدد و ارسال asynchronous ها و batch request ها راهنمایی می کند. علاوه بر این OData خدماتی را برای توسعه به منظور برآوردن نیازهای سفارشی API های RESTful شما فراهم می کند.

مصرف API های OData RESTful آسان است. تکنولوژی OData metadata توصیفی قابل خواندن از مدل داده API ها برای کامپیوتر و ایجاد پروکسی ها و client proxie های جنریک و قدرتمند و ابزار ها را امکان پذیر می کند. برخی از آنها می توانند به شما در تعامل با OData حتی بدون اطلاع از پروتکل کمک کنند.

پروتکل OData و یا Open Data Protocol

پروتکل OData یک استاندارد OASIS است که تعدادی از best practice ها و یا بهترین روش ها برای ساختن و استفاده کردن از REST API ها را تعریف می کند. با استفاده از این پروتکل، امکان ایجاد کردن سرویس های مبتنی بر REST که اجازه بدهند resource ها با استفاده از یک Uniform Resource Locator (URL) مشخص شوند وجود دارد. این resource ها که با استفاده از یک دیتا مدل تعریف می‌شوند، منتشر گردیده و قابل ویرایش توسط web client ها و از طریق HTTP message های ساده می باشد.

پروتکل OData کمک می‌کند تا اپلیکیشن ها تمرکز خود را بر روی business logic گذاشته و دیگر نگران روش های مختلف کار کردن با API به منظور تعریف کردن request header ها و response header ها و status code ها و URL convention ها و media type ها و payload format ها و media format ها و query option ها نباشند. این پروتکل راهنمایی هایی را در رابطه با ردگیری کردن تغییرات، تعریف کردن function ها و action ها برای procedure های reusable و ارسال کردن request ها به صورت asynchronous و batch را در اختیار ما قرار می دهد.

پروتکل OData در سطح اپلیکیشن تعریف شده است و رسالت آن تعامل ایجاد کردن با داده ها از طریق interface های RESTful می باشد. این پروتکل از توصیف دیتا مدل ها ویرایش کردن و کوئری گرفتن از داده ها بر اساس این دیتا مدل ها پشتیبانی می کند. REST API هایی که بر اساس OData تشکیل شده اند، به سادگی قابل کشف و مصرف کردن می باشند. این موضوع به دلیل metadata های مربوط به OData امکان پذیر می باشد. این metadata ها توصیف هایی هستند که برای یک ماشین قابل خواندن می باشند.

بررسی بعضی از اصول های طراحی برای OData

پروتکل OData با بهبود دادن semantic interoperability بین سیستم های مختلف از اصول طراحی زیر پشتیبانی می کند.

• پشتیبانی کردن از اصول REST
• ساده نگه داشتن طراحی و در عین حال فراهم کردن قابلیت گسترش
• امکان ساختن سرویس ها به صورت افزایشی، بدان معنا که یک سرویس ابتدایی به سادگی ساخته می شود و قابلیت‌ های دیگر در صورت ضرورت اضافه می شوند.
• شتیبانی از قابلیت گسترش و یا extensibility، به این معنا که سرویس ها باید بتوانند از functionality های بیشتر بدون break کردن کلاینت ها پشتیبانی کنند.
• پشتیبانی کردن از مکانیزم هایی که بر روی گستره وسیع از دیتا سورس ها کار می کنند. به این معنا که لزوماً با دیتا مدل های relational کار نمی کنند.

پروتکل های OData از دیگر سرویس های مبتنی بر REST متفاوت هستند. دلیل این موضوع نیز آن هست که یک روش یک شکل به منظور توصیف کردن داده ها و دیتا مدل ها را در اختیار ما قرار می دهند. این موضوع باعث بهبود semantic interoperability بین سیستم های مختلف می شود.

سرفصل مطالب آموزش ویدیویی ساختن RESTful API با OData V4 در ASP.NET Core

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

• مقدمه

فصل دوم: آشنایی با REST و OData V4

• مقدمه
• پیش نیازهای این دوره آموزشی
• بررسی Frameworks و Tooling
• چند کلمه درباره REST
• معرفی نسخه نمایشی برنامه
• آموزش عملی: وارد کردن عملی یک Postman Collection
• آموزش عملی: آشنایی با درخواست های AirVinyl و OData Request ها
• جمع بندی

فصل سوم: ایجاد و مصرف کردن یک OData V4 Service

• مقدمه
• بررسی Entity Data Model و Conceptual Model
• آموزش عملی: بررسی دقیق Starter Solution
• آموزش عملی: تعریف Entity Data Model (EDM)
• آموزش عملی: ساختن یک Entity
• بررسی Routing
• آموزش عملی: کار کردن با Attribute-based Routing
• آموزش عملی: ویرایش کردن حجم اطلاعات کنترلی
• آموزش عملی: استفاده از یک Individual Entity
• کار با Property ها و مقادیر خام Property ها
• آموزش عملی: استفاده از Property  های تک تک
• آموزش عملی: استفاده از مقادیر خام Property ها
• آموزش عملی: استفاده از Child Collection Property ها
• جمع بندی

فصل چهارم: بررسی دقیق OData Resource ها

• مقدمه
• آموزش عملی: ایجاد یک Resource
• آموزش عملی: به روز رسانی یک Resource
• آموزش عملی: به روز رسانی جزئی Resource
• آموزش عملی: حذف یک Resource
• جمع بندی

فصل پنجم: Query زدن بر روی داده ها

• مقدمه
• گذراندن گزینه های پرس و جو
• آموزش عملی: انتخاب Property های Specific (قسمت 1)
• نحوه مدیریت Query های OData
• اهمیت Deferred Execution
• آموزش عملی: انتخابProperty های Specific (قسمت 2)
• آموزش عملی: لحاظ کردن Related Entity ها
• آموزش عملی: مرتب سازی Related Entity ها
• آموزش عملی: صفحه بندی از طریق Entity ها
• آموزش عملی: فیلتر کردن Entity ها با استفاده از عملگر های Logical
• آموزش عملی: فیلتر کردن Entity ها با استفاده از عملگر های Lambda
• آموزش عملی: فیلتر کردن Entity ها عملگرهای ریاضی
• بررسی عملگر های Precedence
• آموزش عملی: فیلتر کردن Entity ها با استفاد از عملگر های گروه بندی
• آموزش عملی: فیلتر کردن Entity ها با استفاده از توابع
• آموزش عملی: فیلتر کردن Entity با استفاده از Implicit Literal
• چه چیزی گم شده است؟
• جمع بندی

فصل ششم: کار با Containment و توابع سفارشی و Action ها و Singleton ها

• مقدمه
• کار کردن با Derived Type ها
• آموزش عملی: پشتیبانی از Containment Navigation
• آموزش عملی: تغییر Property های Containment Navigation
• کار با توابع و عملکردهای سفارشی
• آموزش عملی: پشتیبانی از یک عملگر سفارشی
• آموزش عملی: پشتیبانی از Custom Function های Bound شده به یک Entity Collection
• آموزش عملی: پشتیبانی از یک تابع سفارشی بدون محدودیت
• آموزش عملی: پشتیبانی از Custom Action
• آموزش عملی: پشتیبانی از Custom Action محدود به Entity Collection
• کار کردن با Singleton
• آموزش عملی: پشتیبانی از Singleton
• آموزش عملی: بررسی دقیق Singleton
• جمع بندی

فصل هفتم: کار با Derived Type ها و Open Type ها و Batch Processing

• مقدمه
• کار با Derived Type ها
• آموزش عملی: کار با Derived Type ها
• آموزش عملی: ویرایش کردن Derived Type ها
• آموزش عملی: ویرایش عملی Derived Type ها
• کار با Open Type ها
• آموزش عملی: کار با Open Type ها
• آموزش عملی: ویرایش کردن در Open Type ها
• قراردادن چندین Operation در یک Request تک
• آموزش عملی: قراردادن چندین Operation در یک Request تک
• قدم های بعدی
• جمع بندی