ارسال request با Postman CLI

با command postman request می‌توانید یک HTTP request را مستقیم از command line تست و debug کنید. این command بسیاری از قابلیت‌های Postman مثل authentication، environment variableها و test scriptها را در CLI در اختیار شما می‌گذارد.

method می‌تواند GET، POST، PUT، DELETE، PATCH، HEAD یا OPTIONS باشد. اگر method را ننویسید، مقدار پیش‌فرض GET است. آرگومان بعدی URL مقصد است.

postman request

Syntax

postman request [method] <url> [options]

• [method]: HTTP method برای request.
• <url>: URL مقصد request.

Optionها

• --auth-[type]-[parameter] [value]: نوع و پارامترهای authentication را مشخص می‌کند. typeهای پشتیبانی‌شده شامل basic، bearer، digest، oauth1، oauth2، hawk، aws، ntlm و apikey هستند.
• --body [body] یا -d: body request را مشخص می‌کند. هم inline string و هم syntax فایل با @filepath پشتیبانی می‌شود.
• --debug: اطلاعات دقیق debug مثل retryها، redirectها و timing breakdown را نشان می‌دهد.
• --environment [UUID] or [file-path] یا -e: environment را با UUID یا file path مشخص می‌کند و variableها را در URL، header و body resolve می‌کند.
• --form [field] یا -f: داده multipart/form-data با قالب key=value. برای فایل از @filepath استفاده کنید و برای چند field option را تکرار کنید.
• --header [header] یا -H: header با قالب key-value. برای چند header قابل تکرار است.
• --output [path] یا -o: response کامل شامل status، header، body و metadata را در فایل JSON ذخیره می‌کند.
• --response-only: همه خروجی‌ها به جز response body را پنهان می‌کند؛ برای pipe کردن به commandهای دیگر مفید است.
• --redirects-follow-method: هنگام follow کردن redirectهای 3XX، method اصلی HTTP را حفظ می‌کند. پیش‌فرض این است که redirect با GET دنبال شود.
• --redirects-ignore: از follow کردن redirectهای 3XX جلوگیری می‌کند.
• --redirects-max [number]: حداکثر تعداد redirectهای 3XX برای follow کردن. پیش‌فرض محدودیتی ندارد.
• --redirects-remove-referrer: هنگام follow کردن redirect، header مربوط به Referer را حذف می‌کند.
• --retry [number]: تعداد تلاش مجدد برای requestهای failed، مثلا responseهایی مثل ۴۰۰ Bad Request.
• --retry-delay [number]: زمان انتظار بین retryها بر حسب millisecond.
• --script-post-request [script]: JavaScript بعد از اجرای request. هم inline script و هم @filepath پشتیبانی می‌شود.
• --script-pre-request [script]: JavaScript قبل از اجرای request. هم inline script و هم @filepath پشتیبانی می‌شود.
• --timeout [number]: زمان انتظار برای تکمیل request بر حسب millisecond.
• --verbose: جزئیات request و response شامل header، body و metadata را نشان می‌دهد.

Exampleها

postman request GET https://api.example.com/users

postman request POST https://api.example.com/users \
    --body '{"name": "John", "email": "john@example.com"}'

postman request https://api.example.com/data \
    --auth-apikey-key "apikey" \
    --auth-apikey-value "abc123xyz" \
    --auth-apikey-in query

در Postman app هم می‌توانید از یک API request، code snippet مخصوص Postman CLI بسازید، آن را کپی کنید و optionهای لازم برای تست را به آن اضافه کنید.

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