معرفی REST CLIENT توکار ویژوال استودیو 2022
اندازه‌ی قلم متن
تخمین مدت زمان مطالعه‌ی مطلب: یک دقیقه

یکی از امکاناتی که Visual Studio 2022 به ما میدهد، یک REST CLIENT توکار است که با آن میتوانیم بدون Swagger، Post Man یا ابزار‌های مشابه، Api‌های خود را تست کنیم.

برای استفاده از آن، ابتدا یک پروژه‌ی Api را داخل ویژوال استودیو با تنظیمات پیشفرض آن ایجاد میکنیم که شامل یک Controller به نام WeatherForecast است. سپس یک پوشه را درون آن با نامی دلخواه ایجاد میکنیم و داخل آن، یک فایل جدید را با پسوند http میسازیم.

 سپس این فایل http را باز می‌کنیم. اگر شروع به تایپ کردن کنیم، میتوانیم ببینیم که intellisense به ما http method‌های مختلف را نشان میدهد و میتوانیم از آنها استفاده کنیم. برای مثال یک درخواست Get را ایجاد میکنم:
GET https://localhost:7092/WeatherForecast
حال پروژه را اجرا میکنیم و بر روی فلش سبز رنگی که کنار درخواست ایجاد شده، کلیک میکنیم تا درخواست اجرا شود:

 
در اینجا میتوانیم تعدادی متغیر را نیز تعریف کرده و از آنها استفاده کنیم:
@hostname = localhost
@port = 7092
@host = {{hostname}}:{{port}}

GET https://{{host}}/WeatherForecast


حال میخواهیم یک درخواست Post را ایجاد و ارسال کنیم. برای این منظور ابتدا داخل کنترلر WeatherForecast، یک اکشن متد Post را ایجاد میکنیم که در این مثال کاری با دیتای وارد شده نمیکند و فقط آنرا بازگشت می‌دهد:
[HttpPost]
public ActionResult Post(WeatherForecast weatherForecast)
{
    //Code ...
    return Ok(weatherForecast);
}
اکنون میتوانیم مانند زیر یک درخواست Post را با بدنه‌ی json ایجاد کنیم:
@hostname = localhost
@port = 7092
@host = {{hostname}}:{{port}}
@contentType = application/json

POST https://{{host}}/WeatherForecast
Content-Type:{{contentType}}

{
  "date": "2023-03-29",
  "temperatureC": 30,
  "summary": "Hot"
}
نکته: حتما به فاصله‌ی بین Content-Type و براکت‌های بدنه‌ی درخواست، دقت کنید.

به این مورد دقت داشته باشید که برای داشتن چند درخواست در یک فایل، برای جدا کردن آنها از هم باید از ### استفاده کنید:
@hostname = localhost
@port = 7092
@host = {{hostname}}:{{port}}
@contentType = application/json


GET https://{{host}}/WeatherForecast

###

POST https://{{host}}/WeatherForecast
Content-Type:{{contentType}}

{
  "date": "2023-03-29",
  "temperatureC": 30,
  "summary": "Hot"
}
  • #
    ‫۱ سال و ۳ ماه قبل، سه‌شنبه ۲ خرداد ۱۴۰۲، ساعت ۱۰:۵۵
    یک نکته‌ی تکمیلی: اضافه شدن Http Endpoint explorer به Visual Studio 2022 17.6

    نکته‌ی مطلب جاری به Visual Studio 2022 17.5 اضافه شد و در نگارش 17.6، در منوی View –> Other Windows –> Endpoint Explorer امکان دسترسی ساده‌تر به تمامی API endpoints تعریف شده‌ی در کل پروژه‌ی جاری، اضافه شده‌است که اگر روی هر کدام کلیک راست کنید، دو گزینه‌ی مشاهده‌ی پیاده سازی آن (هدایت به اکشن متد مرتبط) و یا ایجاد فایل http. مخصوص آن درنظر گرفته شده‌است: