commandهای workspace در Postman CLI

commandهای workspace در Postman CLI برای اعتبارسنجی، sync و push کردن collectionها، environmentها و specificationهای local به workspaceهای Postman در cloud استفاده می‌شوند. این commandها برای automation در CI/CD و workflowهای Native Git کاربرد دارند.

postman workspace prepare #

این command collectionها و environmentهای local را قبل از push کردن آماده می‌کند. بررسی می‌کند IDها UUID معتبر داشته باشند، در صورت نیاز ID جدید تولید می‌کند و مطمئن می‌شود itemها و responseها ID مناسب دارند.

Syntax #

postman workspace prepare [options]

Optionها #

• --collections-dir <path>: مسیر directory مربوط به collectionها. مقدار پیش‌فرض postman/collections است.
• --environments-dir <path>: مسیر directory مربوط به environmentها. مقدار پیش‌فرض postman/environments است.
• --verbose: نمایش logهای جزئی‌تر.

Configuration #

این command انتظار دارد فایل .postman/resources.yaml در working directory وجود داشته باشد.

مسیر collection و environment می‌تواند relative یا absolute باشد. مسیرهای relative نسبت به .postman/ resolve می‌شوند. فقط فایل‌های JSON معتبر پردازش می‌شوند و pathهای خالی یا فایل‌های غیر JSON با warning کنار گذاشته می‌شوند.

Example #

postman workspace prepare

postman workspace push #

این command تغییرات local collection، environment و specification را به workspace در cloud Postman push می‌کند. در طول sync، عملیات create، update و delete انجام می‌شود تا وضعیت cloud با فایل‌های local هماهنگ شود. اگر duplicate پیدا شود، CLI از شما می‌پرسد element موجود overwrite شود، هر دو نگه داشته شوند یا مورد جدید skip شود.

برای استفاده از این command باید قبلاً با postman login وارد Postman شده باشید.

Syntax #

postman workspace push [options]

Optionها #

• --collections-dir <path>: مسیر directory collectionها. مقدار پیش‌فرض postman/collections است.
• --environments-dir <path>: مسیر directory environmentها. مقدار پیش‌فرض postman/environments است.
• --no-prepare: مرحله prepare را قبل از push رد می‌کند.
• -y یا --yes: همه confirmation promptها را skip می‌کند؛ برای CI/CD مفید است.
• --verbose: نمایش logهای جزئی‌تر.

Workflow اجرای push #

1. Validate: بررسی می‌کند collectionها، environmentها و specificationها به صورت global و در workspace هدف وجود دارند یا نه.
2. Prepare: اگر --no-prepare استفاده نشده باشد، در صورت وجود ID نامعتبر یا missing، prepare اجرا می‌شود.
3. Sync: entityها را برای تطبیق با وضعیت local ایجاد، به‌روزرسانی یا حذف می‌کند.
4. Update Local Files: بعد از create موفق، فایل‌های local را با IDهای برگشتی از server به‌روزرسانی می‌کند.

Configuration #

فایل .postman/resources.yaml باید در working directory باشد. اگر این فایل مسیرهای collection، environment یا specification را مشخص کرده باشد، همان فایل‌ها استفاده می‌شوند و directory scanning انجام نمی‌شود.

فایل .postman/workflows.yaml linkها و تنظیمات link بین collectionهای ساخته‌شده از specification و specificationهای ساخته‌شده از collection را نگه می‌دارد. هنگام اجرای postman workspace push، link و تنظیمات آن هم به cloud push می‌شود.

خود command postman workspace push تغییرات بین یک specification و collection link‌شده به آن را sync نمی‌کند. برای اعمال تغییرات از specification به collection یا برعکس، باید collection یا specification را دستی update کنید.

سیستم در این حالت‌ها فایل workflows.yaml را می‌سازد یا entry جدید به آن اضافه می‌کند:

• وقتی specification و collection تولیدشده از آن را در Local View pull می‌کنید.
• وقتی collection و specification تولیدشده از آن را در Local View pull می‌کنید.
• وقتی در Local View یک collection تولید می‌کنید.

Exampleها #

# Push with automatic prepare and interactive prompts
postman workspace push

# Push without the prepare step
postman workspace push --no-prepare

# Automatic push without prompts (useful for CI/CD)
postman workspace push --yes

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