همکاری API چیست؟

همکاری API فرآیندی است که از طریق آن توسعه‌دهندگان، تسترها، معماران و سایر ذی‌نفعان کسب‌وکار با هم کار می‌کنند تا APIها را تولید کنند و از APIها استفاده کنند.

همکاری API یکی از ستون‌های حیاتی فضای نرم‌افزار امروز است؛ جایی که APIهای داخلی به‌عنوان بلوک‌های اصلی سازنده برنامه‌ها عمل می‌کنند و تلاش‌های توسعه را پیش می‌برند. بسیاری از سازمان‌ها همچنین APIهای شراکتی را می‌سازند و نگهداری می‌کنند که به آن‌ها امکان می‌دهد با کاربران و مشتریان منتخب همکاری کنند، در حالی که برخی دیگر APIها را به‌عنوان محصولات قابل فروش به مصرف‌کنندگان شخص ثالث ارائه می‌دهند. با این که فرآیند همکاری API برای هر نوع API متفاوت خواهد بود، هدف آن این است که کمک کند هر API به‌طور پایدار در دسترس بماند، عملکرد بسیار خوبی داشته باشد، ساده برای استفاده باشد و بتواند نیازهای مصرف‌کنندگان را برآورده کند.

در ادامه، ابتدا نقش همکاری API در دنیای API-first را بررسی می‌کنیم، سپس درباره این که تیم‌ها در مراحل مختلف چرخه عمر API چگونه همکاری می‌کنند و این که پلتفرم Postman API چگونه می‌تواند کمک کند صحبت خواهیم کرد.

مزایای همکاری API در دنیای API-first چیست؟

API-first یک مدل توسعه است که در آن برنامه‌ها به‌عنوان مجموعه‌ای از سرویس‌ها طراحی و ساخته می‌شوند که از طریق API ارائه می‌گردند. تیم‌های API-first پیش از ساخت برنامه‌ها و یکپارچه‌سازی‌های وابسته، APIها را توسعه می‌دهند، که این موضوع از آن‌ها می‌خواهد پیش از نوشته شدن هر کدی، بر سر طراحی API و موارد استفاده مورد انتظار آن به هم‌راستایی کامل برسند. با همکاری در ابتدایی‌ترین مراحل چرخه عمر API، تیم‌های API-first می‌توانند زمینه مشترکی ایجاد کنند که در مسیر توسعه، استقرار و بازنگری APIها آن‌ها را هدایت کند. این سبک همکاری end-to-end در API، حلقه‌های بازخورد را کوتاه می‌کند، که کمک می‌کند APIها در گذر زمان همچنان نیازهای مصرف‌کنندگان را برآورده کنند و کیفیتشان افت نکند.

چگونه از Postman برای همکاری در الگوهای مختلف استفاده کنیم:

همکاری تک‌تیمی (APIهای مخصوص برنامه):

تیم‌ها APIها را عمدتاً برای خودشان می‌سازند. هر API بازتابی از برنامه‌ای است که به آن خدمت می‌کند و هر تیم یک ورک‌اسپیس مرکزی (hub workspace) دارد که تمام APIها و سرویس‌هایشان در آن مستندسازی شده است.

همکاری بین‌تیمی (APIهای قابل استفاده مجدد که به‌صورت داخلی به اشتراک گذاشته می‌شوند):

هر تیم hub مخصوص خود را دارد، اما ورک‌اسپیس‌های اضافی هم برای APIهای قابل استفاده مجدد وجود دارد. هر تیمی که APIهای قابل استفاده مجدد می‌سازد می‌تواند یک «ورک‌اسپیس کشف (Discovery workspace)» ایجاد کند و APIهایی را که ساخته است منتشر کند تا تیم‌های دیگر از میان آن‌ها انتخاب کنند.

همکاری در سطح پلتفرم (APIهای قابل استفاده مجدد برای استفاده شرکت):

یک تیم مرکزی پلتفرم، APIها را برای کل سازمان منتشر می‌کند و به تیم‌های محصولی خدمت می‌دهد که این APIها را مصرف می‌کنند.

همکاری شراکتی (اشتراک‌گذاری کنترل‌شده خارجی):

APIهای شراکتی حد میانه‌ای بین APIهای داخلی و عمومی هستند. آن‌ها مانند APIهای عمومی به‌صورت خارجی به اشتراک گذاشته می‌شوند، اما به گروهی منتخب از شرکای مجاز محدود هستند و سطح بسیار بالاتری از امنیت، کنترل و حاکمیت ارائه می‌دهند. این محیط کنترل‌شده به شرکت‌ها امکان می‌دهد داده‌های حساس‌تر را به اشتراک بگذارند، قابلیت‌های پیشرفته ارائه دهند و فرصت‌هایی برای کسب درآمد از APIهایشان ایجاد کنند.

همکاری عمومی (ساخت اکوسیستم باز):

همکاری روی API عمومی در Postman برای شرکت‌هایی است که می‌خواهند APIهای قابل استفاده مجدد را به مشتریان جدید و موجود توزیع کنند. برای شرکت، API درآمد ایجاد می‌کند یا به رشد کسب‌وکار کمک می‌کند. برای مصرف‌کننده، API امکان نوآوری در ساخت محصولات دیگر را فراهم می‌کند.

تیم‌ها در سراسر چرخه عمر API چگونه همکاری می‌کنند؟

APIها دائماً در حال تکامل هستند تا نیازهای کسب‌وکار و مصرف‌کنندگان را برآورده کنند، و یک چرخه عمر مشخص و تعریف‌شده برای API به تیم‌ها امکان می‌دهد به‌صورت مشارکتی و به شکلی هدفمند و روش‌مند روی APIها تکرار کنند. هر سازمان منحصربه‌فرد است و چرخه عمر API را با ظرافت‌ها و جزئیات خاص خود تعریف می‌کند. با این حال، هر چرخه عمر API شامل مراحل پایه زیر خواهد بود:

مرحله طراحی

طراحی API یک فرآیند به‌شدت مشارکتی است که نیاز دارد همه ذی‌نفعان درباره موارد استفاده و قابلیت‌های مورد انتظار API به هم‌راستایی برسند. آن‌ها همچنین باید تصمیم بگیرند داده‌ها چگونه قالب‌بندی شوند، چه منابعی مورد نیاز است، این منابع چه ارتباطی با یکدیگر دارند و چه متدهایی باید روی endpointهای مرتبط در دسترس باشند. پس از توافق ذی‌نفعان، آن‌ها باید تصمیم‌های طراحی را در یک تعریف API رسمی کنند؛ تعریفی که یک نمایش قابل‌خواندن برای انسان و ماشین از عملکرد مورد انتظار API است.

مرحله توسعه

پس از طراحی API، تیم‌های توسعه می‌توانند کار روی پیاده‌سازی را شروع کنند. توسعه API به‌شدت به روش‌های مؤثر کنترل منبع و کنترل نسخه مانند forking، merging و حل تعارض (conflict resolution) متکی است، که به اعضای تیم امکان می‌دهد موازی کار کنند و در عین حال ریسک تغییرات مخرب را کاهش دهند. تیم‌های توسعه همچنین می‌توانند از قابلیت‌های کامنت‌گذاری استفاده کنند تا در کنار مصنوعات API و خطوط کد مرتبط، به یکدیگر بازخورد دهند، که جابه‌جایی ذهنی (context switching) را کاهش می‌دهد و جریان کاری را سریع‌تر می‌کند.

مرحله تست

تست API به تیم‌ها کمک می‌کند رفتار API را اعتبارسنجی کنند و تأیید کنند که می‌تواند نیازهای مصرف‌کنندگانش را برآورده کند. تست API به‌طور سنتی پس از پایان مرحله توسعه انجام می‌شد، اما به‌صورت فزاینده‌ای رایج شده است که تیم‌های تست و مهندسی در طول توسعه و در خطوط CI/CD با هم همکاری کنند تا APIها را تست کنند. تست زودهنگام و مداوم به این تیم‌ها امکان می‌دهد مشکلات را به‌محض ایجاد شدن شناسایی کنند و همچنین تصمیم‌های طراحی API را پیش از آن‌که ایرادها ریشه‌دار شوند اعتبارسنجی کنند. این رویکرد مقدار سرباری را که برای رفع مشکلات لازم است کاهش می‌دهد و به تیم‌ها امکان می‌دهد APIهای باکیفیت را سریع‌تر به تولید منتشر کنند.

چگونه از Postman برای تست مشارکتی استفاده کنیم

کالکشن‌های Postman زبان اصلی برای این هستند که توسعه‌دهندگان بتوانند به هم توضیح دهند یک API چیست و موارد استفاده مورد انتظار (و غیرمنتظره) آن کدام است. ابزارهای خودکارسازی تست Postman توان کالکشن‌ها را به حوزه تست گسترش می‌دهند و وقتی این‌ها در ورک‌اسپیس‌ها در دسترس قرار می‌گیرند، توسعه‌دهندگان زمینه لازم را خواهند داشت.

راهنمای کلی برای تست APIها:

• تست‌ها را در یک ورک‌اسپیس داخلی مشترک درون تیم نگهداری کنید
• از environmentها برای پارامتریک‌کردن تست‌ها استفاده کنید تا بتوان آن‌ها را در محیط‌های مختلف اجرا کرد
• از Postman CLI برای اجرای تست‌ها در محیط‌های CI/CD استفاده کنید
• تست‌ها را با استفاده از یکپارچه‌سازی git به مخزن GitHub خود وصل کنید
• Postman Monitorها را به سیستم‌های داشبورد مهندسی موجودی که دارید متصل کنید
• درباره نحوه استفاده از Postman برای همکاری و تست API بیشتر یاد بگیرید.

مرحله توزیع

پس از آن‌که یک API طراحی، توسعه، تست و مستقر شد، تیم‌ها باید همکاری کنند تا اطمینان حاصل شود مصرف‌کنندگان می‌توانند آن را کشف کنند. این شامل در دسترس قرار دادن API در یک کاتالوگ API خصوصی یا عمومی است، و همچنین اطمینان از این که فراداده مناسب دارد تا در جست‌وجو پیدا شود. تیم‌ها همچنین باید با هم همکاری کنند تا مستنداتی کامل و به‌روز ایجاد کنند که به مصرف‌کنندگان کمک می‌کند قابلیت‌های API را درک کنند و زمان رسیدن به اولین فراخوانی را کاهش دهند. در نهایت، مرحله توزیع کمک می‌کند APIهای داخلی توسط تیم‌های دیگر دوباره‌کاری نشوند و APIهای عمومی به مخاطب هدف برسند و درآمد ایجاد کنند.

چرا ورک‌اسپیس‌های Postman ابزار برتر همکاری API هستند؟

ورک‌اسپیس‌های Postman هاب‌های همکاری هستند که به تیم‌ها دسترسی مشترک به ابزارهایی می‌دهند که برای حل مسائل به‌صورت گروهی نیاز دارند. ورک‌اسپیس‌ها با عمل‌کردن به‌عنوان یک منبع حقیقت واحد برای تمام کارهای مرتبط با API، به تیم‌ها امکان می‌دهند زمینه مشترک بسازند و در عین حال استانداردهای سازمانی کیفیت API را رعایت کنند. گفتگوها درون ورک‌اسپیس‌ها دقیقاً در کنار مصنوعات مرتبط با API انجام می‌شود، که جابه‌جایی ذهنی را کاهش می‌دهد و فرآیند همکاری را روان‌تر می‌کند. ورک‌اسپیس‌ها همچنین به‌صورت لحظه‌ای به‌روزرسانی می‌شوند و هر تغییر را در تاریخچه نسخه ثبت می‌کنند، که به تیم‌ها امکان می‌دهد سریع حرکت کنند و در عین حال همه در یک مسیر باقی بمانند.

ورک‌اسپیس‌های Postman بسیار انعطاف‌پذیر هستند و می‌توانند به تیم‌ها کمک کنند:

بهبود ورود توسعه‌دهندگان جدید

وقتی یک مهندس نقش جدیدی را شروع می‌کند، باید سریع با مخزن‌ها، ابزارها و جریان‌های کاری تیم آشنا شود، که برخی از آن‌ها ممکن است غیرشهودی یا بد مستند شده باشند. برای حل این مشکل، تیم‌ها می‌توانند ورک‌اسپیس‌های onboarding ایجاد کنند که شامل تمام دارایی‌ها و اطلاعات لازم برای هم‌سطح کردن اعضای جدید است.

تسریع فرآیند توسعه

ورک‌اسپیس‌های توسعه‌دهندگان به‌عنوان محل اصلی همکاری تیم‌های توسعه عمل می‌کنند. آن‌ها شامل مستندات، تست‌ها، سرورهای موک و راهنماهای how-to هستند و می‌توانند در مراحل پیش از تولید، توسعه و پس از تولید چرخه عمر API استفاده شوند. با ارائه یک منبع حقیقت واحد برای تمام مصنوعات API، این ورک‌اسپیس‌ها گلوگاه‌ها را کاهش می‌دهند و زمان ورود به بازار را بهبود می‌بخشند.

بهبود کشف‌پذیری APIهای داخلی

تیم‌ها ممکن است همه APIهایشان را در یک ورک‌اسپیس نگه دارند، در حالی که شرکت‌های بزرگ‌تر ممکن است برای هر API و تیم مسئول آن، ورک‌اسپیس مجزا ایجاد کنند. نگاشت ساختار تیم‌ها به ورک‌اسپیس‌های API یک چارچوب سازمان‌دهی منطقی و مقیاس‌پذیر ایجاد می‌کند که پیدا کردن و دیدن APIهای تحت مدیریت تیم‌های داخلی دیگر را برای توسعه‌دهندگان آسان‌تر می‌کند.

اجرای تست‌ها و عیب‌یابی مشکلات

تست در سراسر چرخه عمر API یکی از ستون‌های مرکزی استراتژی API-first است، زیرا به تیم‌ها امکان می‌دهد مشکلات را سریع شناسایی و رفع کنند. تیم‌های API-first می‌توانند از ورک‌اسپیس‌های اختصاصی تست API استفاده کنند تا تست‌ها را برای APIهایی که در ورک‌اسپیس‌های دیگر در حال توسعه هستند بسازند و اجرا کنند. این تست‌ها همچنین می‌توانند با ابزارهای خط فرمان Postman در فرآیندهای CI هر تیم توسعه ادغام شوند.

ایجاد یکپارچگی در طراحی API

رهبران می‌توانند ورک‌اسپیس‌های راهنمای سبک (style guide) ایجاد کنند که شامل APIهای مرجع، الگوهای طراحی و «بایدها و نبایدها» باشد تا یک استراتژی مؤثر حاکمیت API را در سراسر تمام تیم‌های سازمان ایجاد و اعمال کنند. راهنماهای سبک ورک‌اسپیس‌ها در همان پلتفرمی قرار دارند که تیم‌ها کار می‌کنند، که به توسعه‌دهندگان اجازه می‌دهد با آن‌ها به‌عنوان «اسناد زنده» تعامل کنند و از آن‌ها به‌عنوان نقطه شروع هنگام توسعه و تکرار عناصر API استفاده کنند.

پاسخ به تیکت‌های پشتیبانی

تیم‌های پشتیبانی می‌توانند از ورک‌اسپیس‌ها برای نگهداری یک لاگ از مراحلی که هنگام پاسخ به تیکت‌های مشتری باید انجام دهند استفاده کنند، که به آن‌ها امکان می‌دهد مشکلات را سریع رفع کنند و حجم تیکت‌ها را تحت کنترل نگه دارند. در واقع، برخی توسعه‌دهندگان کالکشن‌ها را مستقیماً با تیم‌های پشتیبانی به اشتراک می‌گذارند، که می‌تواند زمان لازم برای حل یک مشکل را به‌طور چشمگیر کاهش دهد.

ارتباط با توسعه‌دهندگان بیشتر

مهندسان راهکار (solution engineers) می‌توانند از ورک‌اسپیس‌های Postman برای ساخت محیط‌های دمو برای APIهای خارجی استفاده کنند که موارد استفاده اصلی API را به مشتریان بالقوه نشان می‌دهد. این کار به آن‌ها امکان می‌دهد قراردادهای بیشتری ببندند و مشتریان جدید را سریع‌تر راه‌اندازی کنند.

ورک‌اسپیس‌های API عمومی همچنین به تولیدکنندگان API کمک می‌کنند مستقیماً با جامعه خود ارتباط برقرار کنند. ورک‌اسپیس‌های عمومی می‌توانند شامل مستندات، راهنماهای how-to و سایر مطالب مرجع باشند، که زمان رسیدن به اولین فراخوانی را برای مصرف‌کنندگان جدید کاهش می‌دهد. صدها هزار ورک‌اسپیس عمومی در شبکه API عمومی Postman وجود دارد که توسط شرکت‌هایی مانند Salesforce، Stripe، Notion و PayPal ارائه شده‌اند.

Postman چه قابلیت‌های همکاری دیگری ارائه می‌دهد؟

ورک‌اسپیس‌ها که بالاتر درباره آن‌ها صحبت شد، به‌خاطر توانایی‌شان در کمک به تیم‌ها برای حل طیف گسترده‌ای از مسائل پیچیده، در میان قابلیت‌های همکاری Postman برجسته هستند. با این حال، Postman چندین قابلیت همکاری دیگر نیز دارد که مکمل ورک‌اسپیس‌ها هستند و به تولیدکنندگان و مصرف‌کنندگان API امکان می‌دهند در سراسر چرخه عمر API با هم کار کنند. این قابلیت‌ها عبارت‌اند از:

کالکشن‌ها (Collections)

کالکشن‌های Postman گروه‌هایی از درخواست‌های مرتبط هستند و بلوک‌های اصلی برای تمام قابلیت‌های Postman محسوب می‌شوند. برای مثال، کالکشن‌ها به تیم‌ها امکان می‌دهند سرورهای موک، مجموعه‌های تست، مانیتورها و مستندات ایجاد کنند که توسط تیم‌های مختلف در طول چرخه عمر API استفاده می‌شود. کالکشن‌ها همچنین از کامنت‌گذاری و کنترل نسخه پشتیبانی می‌کنند و می‌توان آن‌ها را به‌سادگی با هر ذی‌نفعی در سازمان به اشتراک گذاشت.

سازنده ای‌پی‌آی (The API Builder)

سازنده API در Postman به تیم‌ها امکان می‌دهد به‌صورت مشارکتی یک API را در قالب‌های مختلف مانند OpenAPI، GraphQL و RAML از داخل پلتفرم API طراحی و تعریف کنند. همچنین اجازه می‌دهد اسکیمای API را به‌صورت دوطرفه با GitHub و GitLab همگام‌سازی کنند، که به ایجاد یک منبع حقیقت قابل اشتراک برای تمام کارهای مرتبط با API کمک می‌کند. این موضوع به تیم‌های توسعه و تست اجازه می‌دهد در سراسر چرخه عمر API به‌صورت موازی بر اساس یک اسکیمای مشترک کار کنند.

یکپارچه‌سازی‌ها (Integrations)

چرخه عمر API پیچیده است و نیاز دارد تیم‌ها از ابزارهای متعدد برای ارتباطات، مدیریت زیرساخت، CI/CD، پاسخ به رخداد و پایش عملکرد استفاده کنند. Postman یکپارچه‌سازی‌های داخلی با این ابزارها ارائه می‌دهد، که اصطکاک را کاهش می‌دهد و جریان‌های همکاری را ساده‌تر می‌کند. برای مثال، یکپارچه‌سازی Slack در Postman کمک می‌کند همه ذی‌نفعان از فعالیت‌های API تیم و نتایج Postman Monitor مطلع بمانند.

شبکه API خصوصی (The Private API Network)

تیم‌ها می‌توانند از شبکه API خصوصی Postman برای ساخت یک کاتالوگ از مصنوعات API داخلی استفاده کنند، که کشف‌پذیری API را تسهیل می‌کند و به توسعه‌دهندگان کمک می‌کند از نوشتن کدهای تکراری جلوگیری کنند. علاوه بر کمک به تیم‌ها برای ارتباط و یادگیری از یکدیگر، شبکه API خصوصی به رهبران کسب‌وکار امکان می‌دهد سیاست‌های مؤثر حاکمیت API را در سراسر سازمان تعریف و اعمال کنند.

شبکه API عمومی (The Public API Network)

شبکه API عمومی Postman بزرگ‌ترین هاب مصنوعات API عمومی در جهان است و تولیدکنندگان API را با بیش از ۴۰ میلیون توسعه‌دهنده در سراسر جهان متصل می‌کند. شبکه API عمومی به تولیدکنندگان اجازه می‌دهد مستقیماً با مصرف‌کنندگان خود همکاری کنند، که حلقه‌های بازخورد را کوتاه می‌کند و حجم تیکت‌ها را کاهش می‌دهد.