مستند سازی APIها اغلب به عنوان یک کار خسته کننده و در عین حال ضروری تلقی می‌شود. با استفاده از OpenAPI / Swagger، که به خوبی با ASP.NET Core یکپارچه شده است، می‌توانید این کار را انجام دهید. در دوره ویدیویی Documenting an ASP.NET Core API with OpenAPI / Swagger موسسه Pluralsight که توسط Kevin Dockx تدریس شده است، شما توانایی مستند سازی APIها خودتان را بدست می‌آورید.
ابتدا یاد می‌گیرید که چگونه می‌توانید برای API خود مستندات تهیه کنید و یک رابط کاربری اضافه کنید تا امکان آزمایش API را فراهم کند. در ادامه، نحوه استفاده از ویژگی‌ها و قرارداد‌ها را برای بهبود مشخصات OpenAPI تولید شده، بررسی خواهید کرد. در آخر، نحوه برخورد با احراز هویت، نسخه بندی و سفارشی سازی رابط کاربری را نیز خواهید آموخت. پس از اتمام این دوره، مهارت و دانش OpenAPI لازم جهت مستند سازی صحیح ASP.NET Core API خود را در اختیار خواهید داشت.
فیلم آموزشی «مستند سازی ASP.NET Core API با OpenAPI/Swagger» موسسه پلورال سایت که توسط Kevin Dockx تدریس شده است، دارای زیرنویس انگلیسی است.
Table of Contents:
Course Overview
- Course Overview
Getting Started with OpenAPI / Swagger
- Coming Up
- Course Prerequisites
- Frameworks and Tooling
- Why Use Swagger / OpenAPI to Document Your API?
- Clearing up the Terminology Confusion
- Demo - Introducing the Demo Application
- Summary
Documenting Your First API with OpenAPI / Swagger
- Coming Up
- Demo - Installing Swashbuckle
- Demo - Inspecting the Generated OpenAPI Specification
- Demo - Adding Swagger UI
- Demo - Incorporating XML Comments on Actions
- Demo - Incorporating XML Comments on Model Classes
- Demo - Improving Documentation with Data Annotations
- Demo - Improving Documentation with Examples
- Demo - Ignoring Warnings Where Appropriate
- Demo - Adding API Information and Description
- Summary
Using and Overriding Conventions for OpenAPI Generation
- Coming Up
- The Importance of ApiExplorer
- Why It's Important to Produce Correct Response Types
- Demo - Describing Response Types (Status Codes) with ProducesReponseType
- Demo - Using API Analyzers to Improve the OpenAPI Specification
- 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
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 Support for Schema Variation by Media Type (Output)
- Demo - Supporting Schema Variation by Media Type (Output, ResolveConflictingActions)
- Demo - Supporting Schema Variation by Media Type (Output, IOperationFilter)
- 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
- Working with Multiple OpenAPI Specifications
- Demo - Working with Multiple OpenAPI Specifications
- Versioning with ASP.NET Core’s Built-in Approach
- Demo - Versioning Your API
- Demo - Matching OpenAPI Specifications to API Versions
- Protecting Your API
- Demo - Protecting Your API
- Demo - Adding Authentication Support to the OpenAPI Specification
- Summary
Improving Your Documentation with Advanced Customization
- Coming Up
- Enriching Comments with Markdown
- Demo - Enriching Comments with Markdown
- Demo - Basic UI Customization with the Configuration API
- Supporting Deep Linking
- Demo - Supporting Deep Linking
- Branding the UI
- Demo - Branding the UI by Injecting Custom CSS
- Demo - Branding the UI by Injecting a Custom Index Page
- Summary
می پسندم
به درد نمی خوره
