دکمه Run in Postman یک راه سریع برای شروع کار مصرف‌کنندگان API است. با این دکمه، کاربر می‌تواند کالکشن Postman شما را مستقیم در فضای کاری خودش fork کند و بلافاصله درخواست‌ها را اجرا کند. این دکمه را می‌توانید در وب‌سایت، README، مستندات عمومی API یا صفحه معرفی کالکشن قرار دهید.
این قابلیت فقط برای کالکشن‌هایی در دسترس است که شامل درخواست‌های HTTP باشند. اگر کالکشن فقط شامل توضیح یا آیتم‌های غیر HTTP باشد، گزینه ساخت دکمه برای آن کاربردی نخواهد بود.
چرا دکمه همیشه به‌روز می‌ماند؟
دکمه‌های فعال Run in Postman با تغییرات کالکشن اصلی به‌صورت خودکار به‌روز می‌شوند. یعنی وقتی ناشر API کالکشن اصلی را اصلاح می‌کند، مصرف‌کنندگان از همان مسیر به آخرین نسخه می‌رسند و نیازی نیست لینک یا کد دکمه را هر بار دستی عوض کنید.
پیش‌نیازها
برای ساخت دکمه، کالکشن باید در یک فضای کاری عمومی قرار داشته باشد. اگر کالکشن در فضای کاری خصوصی، تیمی یا داخلی است، ابتدا باید visibility فضای کاری را عمومی کنید یا کالکشن را به یک فضای کاری عمومی منتقل کنید.
اگر منبع API شما به‌صورت فایل OpenAPI یا RAML است، ابتدا آن را به کالکشن تبدیل کنید. این کار با import کردن فایل در Postman یا با تولید کالکشن از API در Spec Hub انجام می‌شود. بعد از ساخته شدن کالکشن، می‌توانید برای آن دکمه Run in Postman بسازید.
ساخت دکمه Run in Postman
- در هدر Postman، منوی ناوبری را باز کنید و وارد Public API Network شوید.
- در پایین سمت چپ، روی Create New کلیک کنید و سپس گزینه Run in Postman button را انتخاب کنید.
- کالکشن موردنظر را انتخاب کنید. در صورت نیاز می‌توانید یک environment هم همراه آن انتخاب کنید.
- روی Next کلیک کنید.
- فرمت کد embed را انتخاب کنید: HTML friendly برای وب‌سایت‌هایی که نیاز به HTML، CSS یا JavaScript دارند، یا Markdown friendly برای README، وبلاگ و سندهای Markdown.
- روی Copy Code کلیک کنید.
- کد را در جایی قرار دهید که می‌خواهید دکمه نمایش داده شود؛ برای مثال در مستندات عمومی API سازمان.
یک مسیر جایگزین هم وجود دارد: در یک فضای کاری عمومی، کالکشن را باز کنید، از منوی View more actions گزینه Share را انتخاب کنید، سپس دوباره از View more actions گزینه Run in Postman را بزنید.
استفاده مصرف‌کننده از دکمه
وقتی کاربر روی دکمه Run in Postman کلیک می‌کند، صفحه‌ای باز می‌شود که از آنجا می‌تواند کالکشن را در فضای کاری خودش fork کند. fork کردن کالکشن به کاربر اجازه می‌دهد تغییرات پیشنهادی را از مسیر pull request به کالکشن اصلی برگرداند.
کاربر همچنین می‌تواند کالکشن را در فضای کاری عمومی مشاهده کند یا یک کپی از آن را import کند. کالکشن‌هایی که با دکمه Run in Postman منتشر می‌شوند، شمارش fork هم دارند؛ این عدد به ناشر و مصرف‌کنندگان نشان می‌دهد توسعه‌دهندگان چقدر از API استفاده کرده‌اند.
بعد از انتشار، دکمه با تغییرات کالکشن اصلی به‌روز می‌ماند. بنابراین مصرف‌کنندگان همیشه به نسخه جدید کالکشن دسترسی دارند، بدون اینکه ناشر مجبور باشد لینک دکمه را دوباره تولید و جایگزین کند.
منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.