commandهای collection در Postman CLI

این صفحه commandهای مربوط به collection در Postman CLI را توضیح می‌دهد. با postman collection run می‌توانید collection را اجرا کنید، با postman collection migrate collectionهای v2.۱ را به قالب v3 YAML تبدیل کنید، و با postman collection lint سازگاری collection با schema قالب v3 را بررسی کنید.

postman collection run

این command یک collection را اجرا می‌کند و نتیجه run را در terminal نشان می‌دهد. اگر وارد Postman شده باشید، نتیجه run به cloud Postman هم ارسال می‌شود. برای اجرای local، collection را با file path مشخص کنید. اگر signed in هستید و می‌خواهید نتیجه به cloud ارسال شود، collection ID را وارد کنید.

Syntax

postman collection run <collection> [options]

<collection> می‌تواند یکی از این موارد باشد:

• مسیر فایل collection برای اجرای local.
• شناسه collection با قالب UUID، وقتی وارد Postman شده‌اید.

Optionهای مهم

• --bail [optional modifiers]: اجرای collection را هنگام اولین error متوقف می‌کند. modifierهای --folder و --failure هم قابل استفاده‌اند.
• --cookie-jar [path]: مسیر فایل JSON cookie jar برای deserialize کردن با کتابخانه tough-cookie.
• --delay-request [number]: تاخیر بین requestها بر حسب millisecond.
• --disable-unicode: symbolهای خروجی را با متن ساده جایگزین می‌کند.
• --environment [UID] or [file-path] یا -e: مسیر فایل environment یا UID آن.
• --env-var key=value: افزودن environment variable از CLI. برای چند مقدار، option را چند بار تکرار کنید.
• --export-cookie-jar [path]: مسیر خروجی cookie jar نهایی بعد از پایان run.
• --global-var key=value: افزودن global variable از CLI.
• --globals [file-path] یا -g: مسیر فایل global variableها.
• --integration-id [ID]: فقط در Postman v11 و قبل‌تر؛ ارسال نتیجه CLI به integration درست در CI/CD.
• --iteration-count [number] یا -n: تعداد دفعات اجرای collection همراه با iteration data.
• --iteration-data [file-path] یا -d: مسیر فایل داده JSON یا CSV برای هر iteration.
• --iteration-data-dataset [dataset-path]: مسیر فایل .dataset.yaml برای استفاده از view هر iteration. با --iteration-data همزمان استفاده نمی‌شود.
• --iteration-data-view [view-name-or-id]: نام یا شناسه view داخل dataset.
• --dataset [dataset-path-or-directory]: dataset یا directory datasetها برای دسترسی scriptها از طریق pm.datasets.
• -i [requestUID] یا -i [folderUID]: فقط request یا folder مشخص را اجرا می‌کند. برای چند item می‌توانید -i را چند بار بیاورید.
• -i [requestName] یا -i [folderName] یا -i [folderPath]: اجرای item بر اساس نام یا path نسبی از root collection.
• --ignore-redirects: از follow کردن خودکار responseهای 3XX جلوگیری می‌کند.
• --insecure یا -k: SSL verification را خاموش می‌کند و self-signed certificate را مجاز می‌داند.
• --mock [file-path]: mock server local را از فایل configuration JSON اجرا می‌کند، collection را در برابر آن اجرا می‌کند و سپس mock server را متوقف می‌کند.
• --no-insecure-file-read: از خواندن فایل‌های خارج از working directory جلوگیری می‌کند.
• --postman-api-key [api-key]: API key برای بارگذاری resourceها از Postman API؛ فقط برای region آمریکا پشتیبانی می‌شود.
• --silent: خروجی terminal را خاموش می‌کند.
• --simulate [file-path]: collection را با simulation روی local mock server اجرا می‌کند. این option در planهای paid در دسترس است.
• --ssl-client-cert-list: مسیر configuration مربوط به client certificateها در قالب JSON.
• --ssl-client-cert: مسیر client certificate با قالب PEM.
• --ssl-client-key: مسیر private key مربوط به client certificate.
• --ssl-client-passphrase: passphrase کلید محافظت‌شده.
• --ssl-extra-ca-certs: مسیر CA certificateهای trusted اضافی با قالب PEM.
• --suppress-exit-code یا -x: exit code پیش‌فرض run را override می‌کند.
• --timeout [number]: زمان انتظار برای کل collection run بر حسب millisecond.
• --timeout-request [number]: زمان انتظار برای response هر request.
• --timeout-script [number]: زمان انتظار برای تکمیل scriptها.
• --verbose: اطلاعات دقیق run و requestهای ارسال‌شده را نشان می‌دهد.
• --working-dir [path]: working directory برای خواندن فایل‌های relative. پیش‌فرض current directory است.
• --reporters [reporter] یا -r [reporter]: تولید report local با formatهای cli، json، junit و html.

Exampleها

postman collection run postman/collections/myCollectionName

postman collection run 12345678-12345ab-1234-1ab2-1ab2-ab1234112a12

postman collection migrate

این command یک collection قدیمی با قالب v2.۱ را به قالب v3 تبدیل می‌کند. خروجی آن یک folder جدید است که برای هر request یک فایل YAML دارد و بعدا با postman collection run قابل اجراست.

Syntax

postman collection migrate <collection-file> [options]

• <collection-file>: مسیر فایل collection قدیمی v2.۱.
• -o یا --output: directory مقصد برای collection جدید. اگر مشخص نشود، خروجی در current directory ذخیره می‌شود.

Exampleها

postman collection migrate your-existing-collection.json

postman collection migrate your-existing-collection.json --output path/to/your-new-collection

postman collection lint

با این command بررسی می‌کنید که collection با schema قالب v3 هماهنگ است یا نه.

Syntax

postman collection lint <collection> [options]

• <collection>: مسیر فایل یا directory مربوط به collection v3.
• -f یا --fail-severity: اگر diagnosticها در سطح مشخص یا بالاتر باشند، command با failure code خارج می‌شود. مقدارهای قابل قبول error و warning هستند.
• -r یا --reporter: format خروجی؛ مقدارهای قابل قبول cli و json هستند.

Exampleها

postman collection lint ./postman/collections

postman collection lint ./postman/collections --fail-severity warning

postman collection lint ./postman/collections/collectionName/requestName.request.yaml --reporter json

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