آموزش تولید قراردادهای OpenAPI در ASP.NET Core 10 - آخرین آپدیت

سرفصل ها و درس ها

شروع کار با OpenAPI و Swagger Getting Started with OpenAPI / Swagger

• مقدمه Introduction

• چرا برای مستندسازی API از Swagger و OpenAPI استفاده کنیم؟ Why Use Swagger / OpenAPI to Document Your API?

• رفع ابهامات در مورد اصطلاحات Clearing up the Terminology Confusion

• توسعه Code-first در مقابل Contract-first Code-first vs. Contract-first Development

• دمو: معرفی اپلیکیشن نمونه Demo: Introducing the Demo Application

تولید اولین مشخصات OpenAPI و رابط کاربری مستندات Generating Your First OpenAPI Specification and Documentation UI

• دمو: شروع از صفر Demo: Getting Started from Scratch

• دمو: افزودن پشتیبانی OpenAPI به یک پروژه موجود Demo: Adding OpenAPI Support to an Existing Project

• دمو: بررسی مشخصات OpenAPI تولید شده Demo: Inspecting the Generated OpenAPI Specification

• دمو: افزودن Scalar Demo: Adding Scalar

• دمو: توصیف عملیات‌ها با استفاده از کامنت‌های XML Demo: Describing Operations with XML Comments

• دمو: توصیف Endpoints در Minimal API Demo: Describing Minimal API Endpoints

• دمو: بهبود مستندات با استفاده از Data Annotations Demo: Improving Documentation with Data Annotations

• دمو: سفارشی‌سازی اطلاعات کلی API Demo: Customizing General API Information

سفارشی‌سازی پیشرفته تولید OpenAPI Further Customizing OpenAPI Generation

• اهمیت ApiExplorer The Importance of ApiExplorer

• دمو: چرا تولید انواع پاسخ‌های (Response Types) صحیح مهم است؟ Demo: Why It's Important to Produce Correct Response Types

• دمو: توصیف انواع پاسخ‌ها و کدهای وضعیت در Minimal API Demo: Describing Response Types and Status Codes (Minimal API)

• دمو: مستندسازی انواع پاسخ‌های پیش‌فرض Demo: Documenting Default Response Types

• دمو: تعیین نوع بدنه درخواست و انواع رسانه‌های پشتیبانی شده Demo: Specifying the Request Body Type and Supported Media Types

• دمو: حذف برخی Endpoints از مستندات OpenAPI Demo: Excluding Endpoints from OpenAPI Documentation

کار با Transformerهای Document، Operation و Schema Working with Document, Operation, and Schema Transformers

• درک مفهوم Transformerها Understanding Transformers

• دمو: ایجاد یک Document Transformer Demo: Creating a Document Transformer

• دمو: ایجاد یک Operation Transformer Demo: Creating an Operation Transformer

• دمو: ایجاد یک Schema Transformer Demo: Creating a Schema Transformer

• دمو: ایجاد یک Transformer پیشرفته برای انتخاب عملیات بر اساس محیط Demo: Creating an Advanced Transformer for Environment-specific Operation Selection

مدیریت نسخه‌های مختلف و احراز هویت Dealing with Different Versions and Authentication

• گروه‌بندی Endpoints در API Grouping API Endpoints

• دمو: پشتیبانی از مشخصات OpenAPI نسخه‌بندی شده Demo: Supporting Versioned OpenAPI Specifications

• محافظت از API شما Protecting Your API

• دمو: محافظت از API با احراز هویت JWT Bearer Demo: Protecting Your API with JWT Bearer Authentication

• دمو: افزودن پشتیبانی احراز هویت به مشخصات OpenAPI Demo: Adding Authentication Support to the OpenAPI Specification

پشتیبانی و کار با تولید OpenAPI در زمان Build Supporting and Working with Build-time OpenAPI Generation

• دلیل استفاده از تولید OpenAPI در زمان Build The Case for Build-time OpenAPI Generation

• دمو: تولید و اعتبارسنجی دستی و Build-time برای OpenAPI Demo: Manual and Build-time OpenAPI Generation and Validation

• دمو: استفاده از یک فایل مشخصات OpenAPI Demo: Using an OpenAPI Specification