آموزش مستند سازی یک API هسته ASP.NET با OpenAPI/Swagger

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

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

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

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

• بالا آمدن Coming Up

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

• چارچوب ها و ابزارها Frameworks and 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 - Installing Swashbuckle

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

• نسخه ی نمایشی - افزودن رابط کاربر Swagger Demo - Adding Swagger UI

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

• نسخه ی نمایشی - تلفیق نظرات XML در Model Classes 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 Using and Overriding Conventions for OpenAPI Generation

• بالا آمدن 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

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

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

• خلاصه Summary

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

• بالا آمدن Coming Up

• مذاکره محتوا با انواع رسانه های خاص فروشنده Content Negotiation with Vendor-specific Media Types

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

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

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

• نسخه ی نمایشی - پشتیبانی از تغییر طرحواره بر اساس نوع رسانه (خروجی ، فیلتر IOperation) 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’s Built-in Approach Versioning with ASP.NET Core’s Built-in Approach

• نسخه ی نمایشی - نسخه دهی & nbsp؛ 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

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

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

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

• مارک UI 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