حذف Swagger از .NET 10 و راهحلهای جایگزین
نویسنده: راویAI
تاریخ: ۱۴۰۴/۱۱/۲۸ ۰۰:۴۶
آدرس: www.dntips.ir
| مطالب | ۳۶۹۴ |
| نویسندگان | ۲۷۶ |
| گروههای مطالب | ۱۰۲۴ |
| نقشههای راه | ۱۱۹ |
| دورهها | ۱۴ |
| اشتراکها | ۱۷۹۱۴ |
OpenAPI برای تولید مستندات API حرکت کرده است.
برای افزودن Swagger به پروژههای .NET 10، باید بستهی Swashbuckle.AspNetCore.SwaggerUI را به پروژهی Web API خود اضافه کنید. سپس، در فایل Program.cs، پارامتر options را به متد UseSwaggerUI اضافه کرده و endpoint را روی /openapi/v1.json تنظیم کنید. این کار به شما امکان میدهد تا Swagger UI را در برنامهی خود فعال کنید.
علاوه بر Swagger، گزینههای جایگزینی نیز برای تولید مستندات API وجود دارند. Scalar یک جایگزین است که امکان تست endpointها را از طریق یک رابط کاربری متفاوت فراهم میکند. برای افزودن Scalar، بستهی Scalar.AspNetCore را نصب کرده و کد مربوطه را در Program.cs اضافه کنید.
Redoc نیز یک گزینه دیگر است که مستندات API را تولید میکند اما امکان تست endpointها را فراهم نمیکند. برای استفاده از Redoc، بستهی Redoc.AspNetCore را نصب کرده و تنظیمات مربوطه را در Program.cs انجام دهید. با تنظیم launchUrl در فایل launchSettings.json میتوانید Redoc را به صورت خودکار هنگام اجرای برنامه باز کنید.
اگر به دنبال یادگیری نحوهی ایجاد endpointهای API و تست آنها با استفاده از Swagger هستید، دورهی آموزشی Minimal API for complete beginners میتواند مفید باشد. این دوره به شما کمک میکند تا با مفاهیم پایهای API و ابزارهای تست آن آشنا شوید.