آمادهسازی فضای کاری عمومی برای شبکه API Postman
مدت زمان مطالعه: : 2 دقیقه
فضای کاری عمومی در Postman صفحه اصلی معرفی API شما برای مصرفکنندگان است. کاربران از همین فضا API را پیدا میکنند، توضیحات را میخوانند، کالکشنهای عمومی را fork میکنند و اولین درخواستهای خود را اجرا میکنند. قبل از عمومی کردن workspace، بهتر است ساختار، توضیحات، اعضای تیم و کالکشنها را آماده کنید.
ایجاد فضای کاری مناسب #
برای انتشار API عمومی، ابتدا یک workspace خصوصی یا تیمی بسازید و بعد از آمادهسازی آن را عمومی کنید. workspace خصوصی فقط برای افراد دعوتشده قابل دسترسی است. workspace تیمی برای اعضای تیم شما در Postman در دسترس است و معمولا برای همکاری داخلی روی API گزینه مناسبتری است.
برای ساخت workspace، از workspace switcher گزینه Create را انتخاب کنید. نام workspace را وارد کنید، نوع Internal را انتخاب کنید، سطح دسترسی مناسب را مشخص کنید و در پایان Create را بزنید. بسته به تنظیمات تیم یا پلن سازمانی، ممکن است ساخت یا عمومی کردن workspace نیاز به تایید داشته باشد.
دعوت از اعضای تیم #
بعد از ساخت workspace، اعضایی را که باید روی مستندسازی، کالکشنها، نمونهها یا آمادهسازی API کار کنند دعوت کنید. workspace را باز کنید، گزینه Invite را بزنید، ایمیل افراد یا گزینههای دعوت را وارد کنید، نقش مناسب را انتخاب کنید و سپس دعوت را ارسال کنید.
با رشد API، میتوانید اعضای بیشتری را اضافه کنید. بهتر است نقشها را بر اساس نیاز واقعی انتخاب کنید تا کنترل تغییرات و دسترسیها سادهتر بماند.
تکمیل جزئیات workspace #
صفحه workspace باید به مصرفکننده توضیح دهد این API چیست، چه مشکلی را حل میکند و از کجا باید شروع کند. برای ویرایش این اطلاعات، workspace را باز کنید و از منوی options وارد Workspace overview شوید. سپس خلاصه، توضیحات و اطلاعات راهنما را اضافه کنید.
قبل از عمومی کردن #
- کالکشنهای عمومی و کالکشن overview را آماده کنید.
- اطلاعات حساس، توکنها، کلیدها و دادههای داخلی را از درخواستها حذف کنید.
- توضیح workspace را طوری بنویسید که کاربر جدید سریع بفهمد از کجا شروع کند.
- با تکامل API، توضیحات workspace و لینکهای راهنما را بهروز نگه دارید.
منبع آموزشی: Postman Docs، بازنویسی و سادهسازیشده برای کاربران فارسیزبان.
