آموزش مستندسازی ASP.NET Core 6 Web API با استفاده از Swagger

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

بررسی اجمالی دوره Course Overview

• بررسی اجمالی دوره Course Overview

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

• بالا آمدن Coming Up

• پیش نیازهای دوره Course Prerequisites

• ابزار سازی Tooling

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

• رفع سردرگمی اصطلاحات Clearing up the Terminology Confusion

• نسخه ی نمایشی - معرفی برنامه آزمایشی Demo - Introducing the Demo Application

• خلاصه Summary

مستندسازی اولین API خود با OpenAPI (Swagger) Documenting Your First API with OpenAPI (Swagger)

• بالا آمدن Coming Up

• نسخه ی نمایشی - شروع کار با Swashbuckle از ابتدا Demo - Getting Started with Swashbuckle from Scratch

• نسخه ی نمایشی - اضافه کردن Swashbuckle به یک پروژه موجود Demo - Adding Swashbuckle to an Existing Project

• نسخه ی نمایشی - بازرسی مشخصات OpenAPI ایجاد شده Demo - Inspecting the Generated OpenAPI Specification

• نسخه ی نمایشی - اضافه کردن SwaggerUI به پروژه Demo - Adding SwaggerUI to the Project

• نسخه ی نمایشی - شامل نظرات XML در Actions Demo - Incorporating XML Comments on Actions

• نسخه ی نمایشی - شامل نظرات XML در کلاس های مدل Demo - Incorporating XML Comments on Model Classes

• نسخه ی نمایشی - بهبود اسناد با حاشیه نویسی داده ها Demo - Improving Documentation with Data Annotations

• نسخه ی نمایشی - بهبود اسناد با مثال Demo - Improving Documentation with Examples

• نسخه ی نمایشی - نادیده گرفتن هشدارها در جایی که مناسب است Demo - Ignoring Warnings Where Appropriate

• نسخه ی نمایشی - اضافه کردن اطلاعات و توضیحات API Demo - Adding API Information and Description

• خلاصه Summary

سفارشی کردن OpenAPI Generation با ویژگی ها و قراردادها Customizing OpenAPI Generation with Attributes and Conventions

• بالا آمدن Coming Up

• اهمیت ApiExplorer The Importance of ApiExplorer

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

• نسخه ی نمایشی - توصیف انواع پاسخ (کدهای وضعیت) با ProducesReponseType Demo - Describing Response Types (Status Codes) with ProducesReponseType

• نسخه ی نمایشی - استفاده از تحلیلگرهای API برای بهبود مشخصات OpenAPI Demo - Using API Analyzers to Improve the OpenAPI Specification

• نسخه ی نمایشی - کار با قراردادهای API Demo - Working with API Conventions

• نسخه ی نمایشی - ایجاد کنوانسیون های سفارشی Demo - Creating Custom Conventions

• صفات در مقابل قراردادها Attributes Versus Conventions

• مذاکره محتوا Content Negotiation

• نسخه ی نمایشی - تعیین نوع بدنه پاسخ با ویژگی Produces Demo - Specifying the Response Body Type with the Produces Attribute

• نسخه ی نمایشی - تعیین نوع بدنه درخواست با ویژگی Consumes Demo - Specifying the Request Body Type with the Consumes Attribute

• خلاصه Summary

ایجاد مشخصات OpenAPI برای سناریوهای ورودی و خروجی پیشرفته Generating OpenAPI Specifications for Advanced Input and Output Scenarios

• بالا آمدن Coming Up

• پشتیبانی از انواع رسانه های خاص فروشنده Supporting Vendor-specific Media Types

• نسخه ی نمایشی - پشتیبانی از انواع رسانه های خاص فروشنده Demo - Supporting Vendor-specific Media Types

• پشتیبانی OpenAPI برای تغییر طرحواره بر اساس نوع رسانه (خروجی) OpenAPI Support for Schema Variation by Media Type (Output)

• نسخه ی نمایشی - پشتیبانی از تنوع طرحواره بر اساس نوع رسانه (خروجی، ResolveConflictingActions) Demo - Supporting Schema Variation by Media Type (Output, ResolveConflictingActions)

• نسخه ی نمایشی - پشتیبانی از تنوع طرحواره بر اساس نوع رسانه (خروجی، IOperationFilter) Demo - Supporting Schema Variation by Media Type (Output, IOperationFilter)

• پشتیبانی OpenAPI برای تغییر طرحواره بر اساس نوع رسانه (ورودی) OpenAPI Support for Schema Variation by Media Type (Input)

• نسخه ی نمایشی - پشتیبانی از تنوع طرحواره بر اساس نوع رسانه (ورودی) Demo - Supporting Schema Variation by Media Type (Input)

• سناریوهای پیشرفته Advanced Scenarios

• خلاصه Summary

برخورد با نسخه های مختلف و حفاظت از اسناد Dealing with Different Versions and Protecting the Documentation

• بالا آمدن Coming Up

• کار با چند مشخصات OpenAPI Working with Multiple OpenAPI Specifications

• نسخه ی نمایشی - کار با چند مشخصات OpenAPI Demo - Working with Multiple OpenAPI Specifications

• نسخه سازی با رویکرد داخلی ASP.NET Core Versioning with ASP.NET Core’s Built-in Approach

• نسخه ی نمایشی - نسخه سازی API شما Demo - Versioning Your API

• نسخه ی نمایشی - مطابقت مشخصات OpenAPI با نسخه های API Demo - Matching OpenAPI Specifications to API Versions

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

• نسخه ی نمایشی - محافظت از API شما Demo - Protecting Your API

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

• خلاصه Summary

بهبود اسناد خود با سفارشی سازی پیشرفته Improving Your Documentation with Advanced Customization

• بالا آمدن Coming Up

• غنی سازی نظرات با Markdown Enriching Comments with Markdown

• نسخه ی نمایشی - غنی سازی نظرات با Markdown Demo - Enriching Comments with Markdown

• نسخه ی نمایشی - سفارشی سازی پایه UI با API پیکربندی Demo - Basic UI Customization with the Configuration API

• پشتیبانی از پیوند عمیق Supporting Deep Linking

• نسخه ی نمایشی - پشتیبانی از پیوند عمیق Demo - Supporting Deep Linking

• برندسازی رابط کاربری Branding the UI

• نسخه ی نمایشی - نام تجاری UI با تزریق CSS سفارشی Demo - Branding the UI by Injecting Custom CSS

• نسخه ی نمایشی - نام تجاری UI با تزریق صفحه فهرست سفارشی Demo - Branding the UI by Injecting a Custom Index Page

• خلاصه Summary