اگر برای API خود فایل یا متن OpenAPI دارید، می‌توانید آن را وارد Postman کنید. Postman از تعریف‌های OpenAPI ۳.۰ و ۳.۱ با فرمت‌های YAML و JSON پشتیبانی می‌کند. در Spec Hub هم OpenAPI ۲.۰، ۳.۰ و ۳.۱ قابل استفاده است.
وارد کردن تعریف OpenAPI در Postman
- در sidebar روی Options کلیک کنید.
- گزینه Import را انتخاب کنید.
- روش import را انتخاب کنید. می‌توانید فایل یا folder آپلود کنید، URL بدهید، متن خام JSON یا YAML را paste کنید یا از code repository وارد کنید.
بعد از import چه کارهایی می‌توانید انجام دهید؟
وقتی تعریف API وارد Spec Hub شد، می‌توانید روی همان specification کار کنید. کارهای رایج بعد از import عبارت‌اند از:
- ویرایش API specification داخل Postman.
- مشاهده و رفع syntax errorهای specification.
- ساخت collection از روی specification برای تست و اجرای requestها.
این روش کمک می‌کند مستندات و تست‌های API از یک تعریف مشترک شروع شوند و بین فایل OpenAPI و کارهای عملیاتی داخل Postman فاصله کمتری داشته باشید.
منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.