نمای کلی مرجع Postman

بخش Reference در مستندات Postman ابزارهایی را معرفی می‌کند که با آن‌ها می‌توانید Postman را به جریان کاری فعلی خود وصل کنید یا روی پلتفرم Postman ابزار بسازید. این بخش شامل Postman API، افزونه VS Code، Newman CLI، SDKها و کتابخانه‌های متن‌باز مرتبط با Collection format است.

اگر می‌خواهید Postman را وارد CI/CD کنید، داده‌های workspace را با API بخوانید، با Collectionها به‌صورت برنامه‌نویسی کار کنید یا از ابزارهای متن‌باز Postman استفاده کنید، این بخش نقطه شروع مناسبی است.

Postman API #

Postman API دسترسی برنامه‌نویسی به collectionها، environmentها، monitorها، mock serverها و منابع دیگر حساب Postman را فراهم می‌کند. با این API می‌توانید فرایندهای تکراری را خودکار کنید، Postman را به pipelineهای CI/CD وصل کنید و داده‌های ذخیره‌شده در حساب خود را بخوانید یا تغییر دهید.

برای استفاده از Postman API به API key نیاز دارید. همچنین این API محدودیت نرخ درخواست دارد، بنابراین برای استفاده سنگین باید rate limitها را در طراحی خود در نظر بگیرید.

Postman MCP Server #

Postman MCP Server به agentهای هوش مصنوعی مثل Claude، Cursor و VS Code اجازه می‌دهد با زبان طبیعی منابع Postman شما را مدیریت کنند. این سرور دستورهای شما را پشت صحنه به Postman API call تبدیل می‌کند.

می‌توانید از remote server از طریق HTTPS استفاده کنید یا local server را با STDIO روی سیستم خود اجرا کنید. این قابلیت برای تیم‌هایی مفید است که می‌خواهند agentها بتوانند با collectionها، workspaceها یا منابع Postman کار کنند.

افزونه Postman برای VS Code #

افزونه Postman برای VS Code قابلیت‌های توسعه و تست API را داخل Visual Studio Code و editorهای پشتیبانی‌شده می‌آورد. با این افزونه می‌توانید بدون جابه‌جایی بین editor و اپلیکیشن Postman، request ارسال کنید، collection و environment را مدیریت کنید، test script بنویسید و collection run انجام دهید.

Newman CLI #

Newman ابزار خط فرمان متن‌باز Postman برای اجرای collectionهاست. با Newman می‌توانید collectionها را از terminal اجرا و تست کنید و آن‌ها را وارد CI/CD کنید. Newman reporterهای داخلی و سفارشی را پشتیبانی می‌کند.

Newman با collection format نسخه ۳ که در Postman v12 و نسخه‌های جدیدتر استفاده می‌شود سازگار نیست. اگر جریان CI/CD جدیدی می‌سازید، بهتر است از Postman CLI استفاده کنید. اگر از قبل Newman دارید، مسیر مهاجرت به Postman CLI را بررسی کنید.

منابع توسعه‌دهنده #

بخش Developer resources مجموعه‌ای از SDKها، کتابخانه‌ها و ابزارهای متن‌باز Postman را پوشش می‌دهد:

• Postman Echo service: یک REST API عمومی برای تست requestها و تمرین قابلیت‌های Postman.
• Postman Collection SDK: ماژول JavaScript برای ساخت، ویرایش و مدیریت Postman Collectionها به‌صورت برنامه‌نویسی.
• Runtime library: کتابخانه‌ای که قابلیت ارسال request در Postman را پشتیبانی می‌کند.
• Code generators: تولید snippetهای کد client در زبان‌های مختلف از روی requestهای Postman.
• API format conversion: تبدیل OpenAPI، Swagger، RAML، GraphQL و WSDL به Postman Collection format.
• Collection Format schema: مشخصاتی که ساختار collectionها در Postman را تعریف می‌کند.

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