نگهداری APIهای عمومی در Postman API Network
مدت زمان مطالعه: : 2 دقیقه
بعد از انتشار API در Postman API Network، کار تمام نمیشود. باید کالکشنها، مستندات و مثالها را با تغییرات واقعی API بهروز نگه دارید تا مصرفکنندگان همیشه به نسخه درست دسترسی داشته باشند. اگر برای همکاری تیمی workspace داخلی آماده کردهاید، بهتر است تغییرات نسخه بعدی را آنجا آماده کنید. در غیر این صورت میتوانید تغییرات را مستقیم در workspace عمومی انجام دهید.
بهروزرسانی کالکشن عمومی با pull request #
در این روش از قابلیت version control در Postman استفاده میکنید. تغییرات را در workspace تیمی آماده میکنید و وقتی آماده انتشار بود، با merge کردن pull request آن را به کالکشن عمومی منتقل میکنید.
ساخت pull request برای کالکشن عمومی #
- workspace تیمی را باز کنید و وارد کالکشنی شوید که تغییر دادهاید.
- کنار کالکشن، منوی View more actions را باز کنید و گزینه Create pull request را انتخاب کنید.
- برای pull request عنوان و توضیح بنویسید و reviewer اضافه کنید.
- روی Create Pull Request کلیک کنید.
بازبینی، تایید و merge کردن pull request #
- workspace تیمی و کالکشن بهروزشده را باز کنید.
- در sidebar سمت راست، تب Pull Requests را باز کنید.
- روی عنوان pull request کلیک کنید.
- تغییرات را بررسی کنید.
- اگر لازم است، در بخش Comments نظر بگذارید.
- اگر تغییرات مورد تایید است، روی Approve کلیک کنید.
- وقتی pull request آماده انتشار بود، روی Merge کلیک کنید، روش merge را انتخاب کنید و دوباره Merge را بزنید.
بعد از merge، Postman تغییرات را به کالکشن عمومی منتقل میکند و مصرفکنندگان API نسخه جدید را میبینند.
بهروزرسانی کالکشن عمومی با Postman API #
اگر میخواهید بهروزرسانی کالکشنها را در جریان CI/CD یا فرایند خودکار انجام دهید، میتوانید از Postman API استفاده کنید. پیشنهاد میشود ابتدا این جریان را روی یک کالکشن تستی امتحان کنید و بعد آن را وارد pipeline کنید.
ساخت کالکشن جدید در workspace تیمی #
در workspace تیمی، از sidebar گزینه Add و سپس Collection را انتخاب کنید. این کالکشن میتواند محل تست و آمادهسازی درخواستهای API برای بهروزرسانی کالکشن عمومی باشد.
ذخیره collection IDها به عنوان variable #
- کالکشن تیمی بهروزشده را باز کنید.
- در sidebar سمت راست، تب Info را باز کنید.
- روی Copy collection ID کلیک کنید.
- این ID را در یک variable در workspace تیمی ذخیره کنید؛ برای مثال
apiReferenceTeamCollectionId. - workspace عمومی و کالکشن عمومی مقصد را باز کنید و ID آن را هم در variable جداگانهای ذخیره کنید؛ برای مثال
apiReferencePublicCollectionId.
گرفتن کالکشن تیمی با API #
- در کالکشن مخصوص workflow، یک request جدید اضافه کنید.
- متد را GET انتخاب کنید و این URL را وارد کنید:
https://api.getpostman.com/collections/:collectionId- در تب Params، مقدار path variable به نام
collectionIdرا برابر variable کالکشن تیمی قرار دهید؛ برای مثالapiReferenceTeamCollectionId. - در تب Authorization احراز هویت Postman API را تنظیم کنید.
- روی Send کلیک کنید. Postman کالکشن تیمی را به شکل JSON برمیگرداند.
بهروزرسانی کالکشن عمومی با API #
- یک request جدید اضافه کنید.
- متد را PUT انتخاب کنید و همان URL را برای کالکشن مقصد وارد کنید:
https://api.getpostman.com/collections/:collectionId- در تب Params، مقدار
collectionIdرا برابر variable کالکشن عمومی قرار دهید؛ برای مثالapiReferencePublicCollectionId. - احراز هویت و authorization را تنظیم کنید.
- در تب Body، JSON کالکشن تیمی را از مرحله قبل قرار دهید.
- قبل از ارسال، IDهای داخلی مثل
_postman_id،idوuidرا از object حذف کنید. این مرحله را میتوانید با script خودکار کنید. - روی Send کلیک کنید.
Postman کالکشن عمومی را با داده جدید جایگزین میکند و تغییرات برای مصرفکنندگان API در دسترس قرار میگیرد.
کدام روش را انتخاب کنید؟ #
- برای همکاری انسانی، بازبینی و کنترل تغییرات، pull request انتخاب بهتری است.
- برای انتشار خودکار، هماهنگی با CI/CD و sync کردن خروجی ابزارهای دیگر، Postman API مناسبتر است.
- در هر دو روش، قبل از انتشار عمومی مطمئن شوید اطلاعات حساس، توکنها و دادههای داخلی در کالکشن قرار نگرفته باشند.
منبع آموزشی: Postman Docs، بازنویسی و سادهسازیشده برای کاربران فارسیزبان.
