یکپارچه‌سازی Postman با APIMatic

Integration مربوط به APIMatic در Postman، یک Postman Collection را به فرمت‌های توضیح API مثل Swagger، RAML یا API Blueprint تبدیل می‌کند و سپس فایل خروجی را به صورت دوره‌ای در GitHub بکاپ می‌گیرد.

پیش‌نیازها

برای راه‌اندازی این integration به موارد زیر نیاز دارید:

• یک حساب APIMatic
• یک API داخل حساب APIMatic؛ قبل از شروع integration باید API را بسازید یا import کنید.
• یک APIMatic API Key
• یک حساب GitHub
• یک repository در GitHub برای ذخیره بکاپ collection

تنظیم Integration با APIMatic

1. از صفحه Home در Postman وارد بخش Integrations شوید.
2. روی Browse All Integrations کلیک کنید.
3. عبارت APIMatic را جست‌وجو و انتخاب کنید.
4. روی Add Integration کلیک کنید.
5. مرورگر یک صفحه جدید با عنوان Authorize Postman باز می‌کند تا به Postman اجازه دسترسی به repositoryهای GitHub بدهید. برای یکی از repositoryهای GitHub گزینه Authorize را انتخاب کنید. اگر وارد GitHub نشده باشید، ابتدا باید sign in کنید.
6. در پنجره Add Integration اطلاعات زیر را وارد کنید:
   • APIMatic API Key: کلید API مربوط به حساب APIMatic.
   • Nickname: یک نام کوتاه و قابل تشخیص برای integration.
   • Workspace: workspaceای که collection مورد نظر در آن قرار دارد.
   • Collection: collectionای که می‌خواهید بکاپ گرفته شود.
   • Repository: repository گیت‌هاب مقصد برای بکاپ.
   • Directory: پوشه‌ای در repository که فایل بکاپ داخل آن قرار می‌گیرد. اگر این پوشه وجود نداشته باشد، هنگام افزودن integration ساخته می‌شود.
   • Filename: نام فایل بکاپ collection.
   • Format: فرمتی که collection با آن ذخیره می‌شود.
   • Branch: نام branch مقصد در GitHub. این branch باید از قبل وجود داشته باشد؛ اگر نام branch اشتباه باشد، integration ساخته نمی‌شود.
7. در پایان روی Add Integration کلیک کنید.

بعد از ساخته شدن integration، می‌توانید روی آن کلیک کنید و جزئیاتی مثل run log را ببینید.

Postman به صورت دوره‌ای collection شما را بررسی می‌کند. اگر تغییری پیدا کند، تغییرات را به صورت خودکار با فرمت JSON در repository شما commit می‌کند.

برای دیدن integrationهای تنظیم‌شده، می‌توانید به صفحه Browse Integrations بروید. همچنین اگر یک collection را باز کنید و از نوار کناری راست وارد بخش Info شوید، integrationهای همان collection را می‌بینید.

منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.