مستندات API وب دات نت با Swagger/OpenAPI [ویدئو]

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

معرفی دوره Course Introduction

• به دوره خوش آمدید Welcome to the Course

• درباره این دوره About This Course

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

• معرفی Introduction

• مروری بر OpenAPI Overview of OpenAPI

• Swagger در مقابل OpenAPI Swagger Versus OpenAPI

• Design-First در مقابل Code-First Design-First Versus Code-First

• پیاده سازی OpenAPI برای دات نت OpenAPI Implementations for .NET

• چرا API های سند؟ Why Document APIs?

• چگونه API ها را مستند کنیم؟ How to Document APIs?

• نمای کلی پروژه آزمایشی Overview of Demo Project

ایجاد OpenAPI با استفاده از Swashbuckle Creating OpenAPI Using Swashbuckle

• معرفی Introduction

• نمای کلی Swashbuckle Overview of Swashbuckle

• مرحله 1: Swashbuckle را نصب کنید Step 1: Install Swashbuckle

• مرحله 2: Swashbuckle را پیکربندی کنید Step 2: Configure Swashbuckle

• نکته ای در مورد ApiExplorer A Note about ApiExplorer

• مروری بر مشخصات OpenAPI تولید شده Overview of Generated OpenAPI Spec

• مرحله 3: SwaggerUI را اضافه کنید Step 3: Add SwaggerUI

• خلاصه Summary

افزودن مستندات با استفاده از Swashbuckle Adding Documentation Using Swashbuckle

• معرفی Introduction

• مرحله 4: فراداده OpenAPI را اضافه کنید Step 4: Add OpenAPI Metadata

• مرحله 5: اسناد را با استفاده از نظرات XML فعال کنید Step 5: Enable Documentation Using XML Comments

• مرحله 6: اسناد را با استفاده از نظرات XML اضافه کنید Step 6: Add Documentation Using XML Comments

• مرحله 7: حاشیه نویسی داده را اضافه کنید Step 7: Add Data Annotations

• مدیریت هشدارهای کامپایلر Handling Compiler Warnings

• خلاصه Summary

ایجاد OpenAPI با استفاده از NSwag Creating OpenAPI Using NSwag

• معرفی Introduction

• NSwag را نصب کنید Install NSwag

• NSwag را پیکربندی کنید Configure NSwag

• SwaggerUI را اضافه کنید Add SwaggerUI

• خلاصه Summary

استفاده از Web API Analyzers Using Web API Analyzers

• معرفی Introduction

• تحلیلگرهای Web API چیست؟ What are Web API Analyzers?

• مرحله 8: Web API Analyzers را فعال کنید Step 8: Enable Web API Analyzers

• مرحله 9: حاشیه نویسی را طبق اخطار اضافه کنید Step 9: Add Annotations as Per Warnings

• خلاصه Summary

استفاده از قراردادهای Web API Using Web API Conventions

• معرفی Introduction

• قراردادهای Web API چیست؟ What are Web API Conventions?

• مرحله 10: اعمال قراردادهای Web API Step 10: Applying Web API Conventions

• مرحله 11: نام‌های اقدام را طبق کنوانسیون به‌روزرسانی کنید Step 11: Update Action Names as Per Conventions

• مرحله 12: قراردادهای API سفارشی ایجاد کنید Step 12: Create Custom API Conventions

• صفات در مقابل قراردادها: از کدام یک استفاده کنیم؟ Attributes Versus Conventions: Which One to Use?

• خلاصه Summary

مستندسازی نسخه های API Documenting API Versions

• معرفی Introduction

• مرحله 13: نسخه API را فعال کنید Step 13: Enable API Versioning

• نیاز به Handling نسخه در طول مستندسازی Need for Handling Version During Documentation

• مرحله 14: اضافه کردن پشتیبانی برای چندین نسخه Step 14: Add Support for Multiple Versions

• مرحله 15: برای هر نسخه سند اضافه کنید Step 15: Add Document for Each Version

• استفاده از Generic Version Handler Using Generic Version Handler

• خلاصه Summary