افزودن type به parameterها و headerها در API Collection

در collectionهای HTTP می‌توانید برای parameterها و headerها type تعریف کنید. این typeها می‌توانند شامل نوع داده، format، مقدار پیش‌فرض، مقدارهای مجاز و required بودن باشند. جزئیاتی که اضافه می‌کنید در مستندات collection هم نمایش داده می‌شود.

افزودن type به parameter یا header #

1. یک request را باز کنید و وارد تب Params یا Headers شوید. اگر لازم است parameter یا header مورد نظر را اضافه کنید.
2. روی query parameter، path parameter یا header مورد نظر hover کنید و گزینه Type را انتخاب کنید.

جزئیات اصلی type #

برای هر parameter یا header می‌توانید این گزینه‌ها را تنظیم کنید:

• Type: نوع داده مثل string، integer، number یا Boolean.
• Required: مشخص می‌کند این بخش اجباری است یا اختیاری.
• Deprecated: نشان می‌دهد استفاده از این parameter یا header توصیه نمی‌شود، هرچند هنوز کار می‌کند.
• Default value: مقدار پیش‌فرض component.
• Possible enum values: مقدارهای مجاز. برای همه typeها به جز Boolean قابل استفاده است. می‌توانید هر مقدار را جداگانه وارد کنید یا یک فهرست comma-separated مثل red,green,blue بچسبانید.

گزینه‌های مخصوص string #

اگر type را string انتخاب کنید، می‌توانید format رشته را هم مشخص کنید؛ مثلا date، time یا email. همچنین می‌توانید pattern مجاز را با regex وارد کنید، اما اگر format انتخاب کرده باشید نمی‌توانید هم‌زمان pattern تعریف کنید. برای string امکان تعیین Min length و Max length هم وجود دارد.

گزینه‌های مخصوص integer و number #

برای typeهای integer و number می‌توانید Min value و Max value تعریف کنید تا Postman مقدارهای خارج از محدوده را قبل از ارسال request نشان دهد.

ذخیره و همگام‌سازی #

بعد از تنظیم typeها، روی Save کلیک کنید تا تغییرات در request ذخیره شود. اگر قبلا از collection یک specification تولید کرده‌اید، بعد از این تغییرات specification را هم به‌روزرسانی کنید تا با collection هماهنگ بماند.

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