Postman Collection SDK یک ماژول Node.js برای کار برنامه‌نویسی با Collectionهای Postman است. اگر می‌خواهید Collection را در یک ابزار داخلی، اسکریپت تست، یا جریان CI/CD بسازید و تغییر دهید، این SDK به شما اجازه می‌دهد ساختار Collection را به‌صورت شیءهای جاوااسکریپتی مدیریت کنید.
چه زمانی از Collection SDK استفاده کنیم؟
- وقتی Collectionها باید به‌صورت پویا از داده‌ها یا تعریف‌های API ساخته شوند.
- وقتی می‌خواهید درخواست‌ها، متغیرها، احراز هویت و آیتم‌های Collection را با کد تغییر دهید.
- وقتی خروجی نهایی قرار است با Postman CLI یا ابزارهای مشابه اجرا شود.
دسترسی و نصب
پروژه Collection SDK متن‌باز است و از طریق npm یا مخزن GitHub قابل نصب است. منابع اصلی:
نمونه خواندن یک Collection
نمونه زیر یک فایل Collection را می‌خواند، آن را به شیء Collection تبدیل می‌کند و سپس خروجی JSON آن را چاپ می‌کند:
var fs = require('fs'),
Collection = require('postman-collection').Collection,
myCollection;
myCollection = new Collection(JSON.parse
(fs.readFileSync('sample-collection.json').toString()));
console.log(myCollection.toJSON());
نکته عملی
اگر فقط می‌خواهید یک Collection آماده را اجرا کنید، معمولا Postman CLI ساده‌تر است. اما اگر قبل از اجرا باید Collection را بسازید، آیتم‌ها را تغییر دهید، متغیرها را تنظیم کنید یا خروجی سفارشی تولید کنید، Collection SDK ابزار مناسب‌تری است.
گام بعدی
بعد از ساخت یا تغییر Collection با SDK، می‌توانید آن را در گردش کار خط فرمان یا CI/CD با Postman CLI اجرا کنید.
منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.