ارسال پارامتر و Body در درخواست‌های Postman

در Postman می‌توانید همراه درخواست HTTP داده بفرستید. این داده می‌تواند به شکل پارامترهای Query و Path باشد یا در Body درخواست ارسال شود. Body هم می‌تواند قالب‌هایی مثل Form data، URL-encoded، Raw، Binary یا GraphQL داشته باشد.

ارسال پارامترهای درخواست #

پارامترها را می‌توانید مستقیم در کادر URL وارد کنید یا از تب Params استفاده کنید.

• Query parameter به انتهای URL اضافه می‌شود و بعد از علامت ? می‌آید؛ مثلا ?id=1&type=new.
• Path parameter بخشی از مسیر URL است و معمولا با دو نقطه مشخص می‌شود؛ مثلا /customer/:id.

اگر Query parameter را در URL یا تب Params وارد کنید، Postman مقدار را در همه محل‌های مرتبط به‌روزرسانی می‌کند. توجه کنید که پارامترها به‌صورت خودکار URL-encode نمی‌شوند؛ برای Encode دستی می‌توانید روی متن انتخاب‌شده راست‌کلیک کنید و EncodeURIComponent را انتخاب کنید.

برای Path parameter، نام پارامتر را بعد از دو نقطه در URL بنویسید؛ مثلا :id. سپس از تب Params یا با نگه داشتن ماوس روی مسیر URL می‌توانید مقدار آن را تنظیم کنید.

برای پارامترها می‌توانید توضیح هم بنویسید تا هم‌تیمی‌ها یا خوانندگان مستندات API راحت‌تر متوجه کاربرد آن‌ها شوند. اگر ترجیح می‌دهید پارامترها را به شکل متن ساده وارد کنید، از گزینه Bulk Edit استفاده کنید.

ارسال Body همراه درخواست #

وقتی می‌خواهید داده ساختاریافته اضافه یا ویرایش کنید، معمولا باید Body بفرستید. مثلا برای ساخت مشتری جدید ممکن است اطلاعات مشتری را در قالب JSON بفرستید. Body معمولا با متدهای POST، PUT و PATCH استفاده می‌شود.

در تب Body نوع داده را انتخاب می‌کنید. اگر نیازی به Body ندارید، گزینه none را نگه دارید.

Form data #

فرم‌های وب معمولا داده را با قالب multipart/form-data ارسال می‌کنند. در Postman می‌توانید در تب Body گزینه form-data را انتخاب کنید و داده‌ها را به شکل Key/Value وارد کنید.

برای ارسال فایل، کنار نام Key نوع مقدار را از Text به File تغییر دهید و فایل را انتخاب کنید. مسیر فایل نسبت به Working Directory محلی شما ذخیره می‌شود.

URL-encoded #

اگر API شما داده را به شکل URL-encoded می‌خواهد، در تب Body گزینه x-www-form-urlencoded را انتخاب کنید. مقدارها را به شکل Key/Value وارد می‌کنید و Postman قبل از ارسال آن‌ها را Encode می‌کند.

گاهی Form data و URL-encoded با هم اشتباه گرفته می‌شوند. اگر مطمئن نیستید کدام لازم است، مستندات API یا توضیح ارائه‌دهنده API را بررسی کنید.

Raw data #

در حالت Raw می‌توانید هر داده متنی را وارد کنید. نوع داده را از فهرست انتخاب کنید؛ مثل Text، JavaScript، JSON، HTML یا XML. Postman بر اساس نوع انتخاب‌شده Syntax Highlighting و Header مناسب را اعمال می‌کند.

اگر لازم باشد، می‌توانید Header مربوط به Content-Type را دستی تغییر دهید. همچنین می‌توانید در Body از Variableها و Vault secretها استفاده کنید. برای JSON خام، کامنت‌های تک‌خطی و چندخطی هنگام ارسال حذف می‌شوند.

Binary data #

برای ارسال فایل‌هایی مثل تصویر، صوت، ویدیو یا فایل متنی می‌توانید از گزینه binary در تب Body استفاده کنید. فایل را از سیستم محلی انتخاب می‌کنید و Postman مسیر فایل را در درخواست ذخیره می‌کند.

GraphQL #

برای ارسال Queryهای GraphQL، در تب Body گزینه GraphQL را انتخاب کنید. Query را در بخش Query وارد کنید و اگر Variable دارید، مقدارها را در بخش GraphQL Variables بنویسید.

منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.