Redoc 📘

ءRedoc مستندات API را تولید می‌کند، اما اجازه‌ی تست endpointها را نمی‌دهد.

برای اضافه کردن Redoc، پکیج Redoc.AspNetCore را در پروژه‌ی Web API خود نصب کنید.

سپس کد زیر را به Program.cs اضافه کنید:

// Program.cs
if (app.Environment.IsDevelopment()) 
{
  app.MapOpenApi();
  app.UseReDoc(options => 
  {
    options.RoutePrefix = "docs";
    options.SpecUrl = "/openapi/v1.json";
  });
}

برای اجرای برنامه همراه با Redoc، فایل launchSettings.json را باز کنید.

مقدار launchBrowser را روی true بگذارید و launchUrl را برابر با docs تنظیم کنید (یا هر مقداری که در options.RoutePrefix گذاشته‌اید).

{
  "$schema": "https://json.schemastore.org/launchsettings.json",
  "profiles": {
    "http": {
      "commandName": "Project",
      "dotnetRunMessages": true,
      "launchBrowser": false,
      "applicationUrl": "http://localhost:5155",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "https": {
      "commandName": "Project",
      "dotnetRunMessages": true,
      "launchBrowser": true,
      "launchUrl": "docs",
      "applicationUrl": "https://localhost:7284;http://localhost:5155",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

جایگزین‌ها به‌جای استفاده از UI 🧩

ممکن است نخواهید یک رابط کاربری (UI) شامل تمام endpointهای خود را در دسترس قرار دهید.

فایل http. 📄

وقتی یک Web API می‌سازید، یک فایل http. به‌صورت پیش‌فرض ایجاد می‌شود. اگر از Visual Studio استفاده می‌کنید، این فایل به شما اجازه می‌دهد endpoint پیش‌فرض WeatherForecast را تست کنید. وقتی برنامه در حال اجراست، می‌توانید درخواست‌ها را ارسال کنید یا آن‌ها را مستقیماً دیباگ کنید.

در Visual Studio، اگر بخواهید endpointهای بیشتری از برنامه‌ی خود را به فایل http. اضافه کنید، به مسیر زیر بروید:

View > Other Windows > Endpoints Explorer

این بخش لیستی از تمام endpointهای موجود در Web API شما را نمایش می‌دهد.

با راست‌کلیک روی یک endpoint و انتخاب گزینه‌ی Generate request،
ءVisual Studio آن درخواست را به فایل http. اضافه می‌کند.

Postman 📬

گزینه‌ی دیگر استفاده از Postman است. شما می‌توانید endpointها را به‌صورت دستی اضافه کنید یا یک سند OpenAPI را ایمپورت کنید.

برای ایمپورت کردن یک سند OpenAPI، برنامه‌ی خود را اجرا کنید و به مسیر زیر بروید:
/openapi/v1.json

آدرس URL را کپی کنید.

در Postman، به بخش Import بروید و URL را Paste کنید.
ءPostman سپس تمام endpointها را ایمپورت می‌کند تا بتوانید آن‌ها را تست کنید. 🚀

🔖هشتگ‌ها:
#DotNet #OpenAPI #Postman #HttpFile #WebAPI #ASPNetCore #DeveloperTools