آمادهسازی APIهای عمومی برای شبکه API Postman
مدت زمان مطالعه: : 2 دقیقه
برای انتشار API در شبکه API Postman، ابتدا باید تیم ناشر، فضای کاری عمومی و کالکشنهای عمومی خود را آماده کنید. این آمادهسازی باعث میشود وقتی workspace را عمومی میکنید، کاربران بتوانند API شما را راحتتر بفهمند، fork کنند و در پروژههای خود به کار ببرند.
آمادهسازی و تایید تیم ناشر #
میتوانید تیم ناشر خود را برای تایید توسط Postman آماده کنید. وقتی تیم تایید شود، کنار نام تیم نشان تایید نمایش داده میشود. این نشان برای مصرفکنندگان API پیام اعتماد دارد و کمک میکند بین ناشران دیگر بهتر دیده شوید.
برای جزئیات بیشتر، مستند Become a verified publisher on the Postman API Network را ببینید.
آماده کردن workspace عمومی #
workspace عمومی جایی است که کاربران APIهای شما را پیدا میکنند، با قابلیتهای آنها آشنا میشوند و کالکشنهای عمومی را به workspace خودشان fork میکنند. برای شروع، یک workspace بسازید و اعضای تیم را به آن دعوت کنید.
برای ادامه، مستند Prepare your public workspace for the Postman API Network را ببینید.
آماده کردن کالکشنهای عمومی #
ابتدا یک کالکشن مرجع API بسازید. سپس کالکشنی بسازید که نقطه شروع مناسبی برای مصرفکنندگان API باشد. وقتی APIهای عمومی را منتشر میکنید، کاربران میتوانند این کالکشنها را fork کنند و سریعتر شروع کنند.
برای جزئیات بیشتر، مستند Prepare your public collections for the Postman API Network را ببینید.
مرتبسازی و کامل کردن کالکشنها #
فقط اضافه کردن درخواستها به کالکشن کافی نیست. کاربران انتظار دارند کالکشنها مرتب، قابل فهم و همراه با توضیح باشند. کالکشن خوب باید API را معرفی کند، قابلیتهای مهم را روشن کند و تجربهای ساده برای توسعهدهنده بسازد.
برای ادامه، مستند Curate your public collections for the Postman API Network را ببینید.
آماده کردن workspace تیمی #
بهتر است نسخه بعدی API را در یک فضای غیرعمومی آماده کنید؛ جایی که اعضای تیم بتوانند همکاری کنند، تغییرات را بررسی کنند و بازخورد بدهند. وقتی نسخه جدید آماده شد، میتوانید با merge کردن pull request، آخرین تغییرات را در اختیار کاربران عمومی قرار دهید.
برای جزئیات بیشتر، مستند Prepare your team workspace for team collaboration را ببینید.
منبع آموزشی: Postman Docs، بازنویسی و سادهسازیشده برای کاربران فارسیزبان.
