ابزارهای تبدیل API در Postman به شما کمک می‌کنند تعریف‌های API را از فرمت‌هایی مثل OpenAPI، Swagger، RAML، GraphQL و WSDL به فرمت Postman Collection تبدیل کنید. این تبدیل‌گرها به‌صورت ماژول‌های Node.js ارائه می‌شوند و می‌توانند در pipelineهای CI/CD هم استفاده شوند.
چه زمانی به تبدیل‌گرها نیاز داریم؟
- وقتی مستندات یا قرارداد API شما در قالب OpenAPI، Swagger، RAML، GraphQL یا WSDL نگهداری می‌شود.
- وقتی می‌خواهید از روی تعریف API، Collection قابل اجرا در Postman بسازید.
- وقتی تبدیل Collection باید خودکار و تکرارپذیر باشد، مثلا در CI/CD.
دسترسی به تبدیل‌گرها
هر تبدیل‌گر یک پروژه متن‌باز است و می‌تواند از npm یا مخزن GitHub در برنامه Node.js شما استفاده شود. بسته مناسب را بر اساس فرمت ورودی انتخاب کنید:
- تبدیل OpenAPI ۳.۰/۳.۱ و Swagger ۲.۰ به Postman
- تبدیل RAML ۱.۰ به Postman
- تبدیل GraphQL به Postman
- تبدیل WSDL به Postman
جایگاه در workflow توسعه
یک الگوی رایج این است که تعریف API در مخزن کد نگهداری شود، در CI/CD اعتبارسنجی شود، سپس با تبدیل‌گر مناسب به Postman Collection تبدیل شود. بعد از آن می‌توانید Collection تولیدشده را وارد Postman کنید یا با Postman CLI اجرا کنید.
گام‌های بعدی
- Collection تولیدشده را در Postman import کنید و درخواست‌ها را بازبینی کنید.
- اگر اجرای خودکار نیاز دارید، Collection را در pipeline با Postman CLI اجرا کنید.
- برای پروژه‌هایی که چند فرمت API دارند، تبدیل‌گرها را جداگانه و با تنظیمات مشخص در CI/CD نگه دارید تا خروجی‌ها قابل پیش‌بینی باشند.
منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.