تست API با Postman؛ ارسال درخواست، بررسی پاسخ و احراز هویت

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

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

Postman چیست و چه کاربردی دارد؟

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

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

مهم‌ترین کاربردهای Postman عبارت‌اند از:

• ارسال درخواست‌های HTTP مانند GET، POST، PUT و DELETE
• بررسی پاسخ‌های دریافتی از API
• مشاهده و تحلیل اطلاعات JSON
• آزمایش روش‌های مختلف احراز هویت
• مدیریت درخواست‌ها در قالب Collection
• تعریف متغیر برای آدرس‌ها و اطلاعات تکراری
• نوشتن و اجرای تست‌های خودکار برای API
• در پروژه‌هایی که API در کنار پایگاه داده و سرویس‌های دیگر اجرا می‌شود، مدیریت محیط توسعه اهمیت زیادی دارد. برای آشنایی با اجرای چند سرویس در کنار یکدیگر، می‌توانید مقاله اجرای پروژه چندکانتینری با Docker Compose را مطالعه کنید.

نصب و راه‌اندازی Postman

برای شروع کار با Postman می‌توانید نسخه دسکتاپ یا نسخه تحت وب آن را استفاده کنید.

۱. وارد وب‌سایت رسمی Postman شوید:

https://www.postman.com/downloads/

۲. نسخه مناسب سیستم‌عامل خود را انتخاب و دانلود کنید.

۳. نرم‌افزار را نصب و اجرا کنید.

۴. در صورت نیاز، وارد حساب کاربری خود شوید یا یک حساب جدید بسازید.

پس از اجرای برنامه، می‌توانید یک درخواست جدید ایجاد کنید و آدرس API موردنظر را در قسمت مربوط به URL وارد کنید.

منبع : مستندات رسمی Postman برای ارسال درخواست

آشنایی با اجزای اصلی درخواست در Postman

برای تست REST API با Postman ابتدا باید با بخش‌های مختلف یک درخواست آشنا شوید.

۱. آدرس API یا Endpoint

هر درخواست API به یک آدرس مشخص ارسال می‌شود که به آن Endpoint می‌گویند.

برای مثال:

https://postman-echo.com/get

این آدرس برای آزمایش درخواست GET استفاده می‌شود.

۲. متدهای HTTP

متد HTTP مشخص می‌کند که درخواست شما چه عملیاتی را روی منابع سرور انجام دهد.

۳. پارامترها یا Params

گاهی لازم است هنگام ارسال درخواست، اطلاعاتی را به آدرس API اضافه کنید. این اطلاعات معمولاً در بخش Params وارد می‌شوند.

برای مثال:

https://postman-echo.com/get?name=Ali&age=25

در این مثال، دو پارامتر name و age به درخواست اضافه شده‌اند.

۴. هدرها یا Headers

هدرها اطلاعات تکمیلی درخواست را مشخص می‌کنند. برای مثال، می‌توان نوع محتوای ارسالی را با هدر زیر مشخص کرد:

Content-Type: application/json

۵. بدنه درخواست یا Body

در درخواست‌هایی مانند POST و PUT ممکن است لازم باشد اطلاعاتی به سرور ارسال کنید. این اطلاعات در بخش Body قرار می‌گیرند.

برای ارسال داده‌های JSON، معمولاً گزینه raw و سپس نوع JSON انتخاب می‌شود.

نحوه ارسال درخواست GET در Postman

درخواست GET برای دریافت اطلاعات از سرور استفاده می‌شود. برای تمرین، از سرویس آزمایشی Postman Echo استفاده می‌کنیم.

مراحل انجام کار:

۱. یک درخواست جدید در Postman باز کنید.

۲. متد درخواست را روی GET قرار دهید.

۳. آدرس زیر را وارد کنید:

https://postman-echo.com/get

۴. روی دکمه Send کلیک کنید.

پس از ارسال درخواست، پاسخ سرور در قسمت Response نمایش داده می‌شود.

برای تمرین پارامترها می‌توانید به بخش Params بروید و مقادیر زیر را وارد کنید:

Postman این پارامترها را به درخواست اضافه می‌کند. پس از ارسال مجدد، می‌توانید مقادیر را در پاسخ دریافتی مشاهده کنید.

نحوه ارسال درخواست POST در Postman

متد POST معمولاً برای ارسال اطلاعات به سرور و ایجاد یک منبع جدید استفاده می‌شود.

برای آزمایش این متد، آدرس زیر را وارد کنید:

https://postman-echo.com/post

سپس مراحل زیر را انجام دهید:

۱. متد درخواست را روی POST قرار دهید.

۲. وارد بخش Body شوید.

۳. گزینه raw را انتخاب کنید.

۴. نوع داده را روی JSON قرار دهید.

۵. کد زیر را وارد کنید:

{
  "name": "Ali",
  "email": "ali@example.com",
  "role": "developer"
}

۶. روی Send کلیک کنید.

در پاسخ دریافتی می‌توانید اطلاعات ارسال‌شده را مشاهده کنید. این روش برای بررسی نحوه ارسال داده‌های JSON به API کاربرد دارد.

بررسی متدهای PUT، PATCH و DELETE

علاوه بر GET و POST، در تست API با Postman می‌توانید متدهای دیگری را نیز بررسی کنید.

متد PUT

از PUT معمولاً برای جایگزینی کامل اطلاعات یک منبع استفاده می‌شود.

آدرس آزمایشی:

https://postman-echo.com/put

متد PATCH

از PATCH برای ویرایش بخشی از اطلاعات یک منبع استفاده می‌شود.

آدرس آزمایشی:

https://postman-echo.com/patch

متد DELETE

این متد برای ارسال درخواست حذف یک منبع استفاده می‌شود.

آدرس آزمایشی:

https://postman-echo.com/delete

این Endpointها برای بررسی ساختار درخواست‌ها مناسب‌اند؛ اما پاسخ موفق آن‌ها به معنی حذف یا تغییر اطلاعات واقعی در یک پایگاه داده نیست.

چگونه پاسخ API را در Postman بررسی کنیم؟

پس از ارسال درخواست، بخش Response اطلاعات مهمی درباره نتیجه ارتباط با سرور نمایش می‌دهد.

برای بررسی پاسخ JSON در Postman بهتر است چند بخش را بشناسید:

۱. Status Code

کد وضعیت نشان می‌دهد درخواست از نظر HTTP چه نتیجه‌ای داشته است.

مرجع کدهای وضعیت HTTP

۲. Response Body

در این قسمت محتوای پاسخ سرور نمایش داده می‌شود. اگر پاسخ از نوع JSON باشد، می‌توانید ساختار داده‌ها را به‌صورت مرتب مشاهده کنید.

۳. Response Headers

هدرهای پاسخ اطلاعاتی مانند نوع محتوا و تنظیمات مربوط به پاسخ سرور را نشان می‌دهند.

۴. Response Time

زمان پاسخ‌گویی سرور نیز نمایش داده می‌شود. این مقدار می‌تواند برای بررسی اولیه سرعت پاسخ API مفید باشد؛ البته به‌تنهایی معیار کافی برای ارزیابی عملکرد یک سرویس نیست.

برای بررسی عمیق‌تر امنیت ارتباط میان مرورگر و سرور، ابزارهایی مانند Burp Suite نیز کاربرد دارند. این ابزار امکان مشاهده، تحلیل و تغییر درخواست‌ها و پاسخ‌های HTTP را در محیط آزمایش فراهم می‌کند.

احراز هویت API در Postman

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

روش‌های مختلفی برای احراز هویت وجود دارد.

_Basic Auth

در این روش، نام کاربری و رمز عبور برای احراز هویت ارسال می‌شوند. در Postman می‌توانید از بخش Authorization گزینه Basic Auth را انتخاب کنید و اطلاعات موردنیاز را وارد کنید.

_API Key

در روش API Key، یک کلید اختصاصی برای شناسایی و مجازکردن درخواست استفاده می‌شود. محل ارسال این کلید به طراحی API بستگی دارد و ممکن است در Header یا Query Parameter قرار بگیرد.

_Bearer Token

در روش Bearer Token، یک توکن برای دسترسی به API استفاده می‌شود.

برای استفاده از این روش در Postman:

۱. وارد بخش Authorization شوید.

۲. گزینه Bearer Token را انتخاب کنید.

۳. توکن معتبر را در قسمت Token قرار دهید.

۴. درخواست را ارسال کنید.

در این روش، Postman توکن را در هدر Authorization قرار می‌دهد.

_OAuth 2.0

OAuth 2.0 چارچوبی برای اعطای دسترسی محدود به منابع است. این روش در سرویس‌هایی استفاده می‌شود که به سازوکارهای پیشرفته‌تر مدیریت دسترسی نیاز دارند.

مدیریت درخواست‌ها با Collection و Environment

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

Collection چیست؟

Collection در Postman مجموعه‌ای از درخواست‌های مرتبط است که می‌توانید آن‌ها را در یک محل ذخیره و دسته‌بندی کنید.

برای مثال، اگر در حال بررسی API یک فروشگاه اینترنتی هستید، می‌توانید درخواست‌های مربوط به محصولات، کاربران و سفارش‌ها را در Collectionهای جداگانه قرار دهید.

Environment چیست؟

Environment در Postman به شما اجازه می‌دهد متغیرهایی برای اطلاعاتی مانند آدرس پایه API یا توکن تعریف کنید.

برای مثال، می‌توانید متغیری با نام زیر بسازید:

baseUrl

و مقدار آن را برابر آدرس اصلی API قرار دهید.

سپس به‌جای نوشتن آدرس کامل در هر درخواست، از متغیر زیر استفاده کنید:

{{baseUrl}}/products

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

نوشتن تست خودکار API در Postman

یکی از قابلیت‌های مهم Postman امکان نوشتن تست با JavaScript است. با استفاده از این قابلیت می‌توانید پس از دریافت پاسخ، شرایط مشخصی را بررسی کنید.

برای مثال، فرض کنید می‌خواهید مطمئن شوید پاسخ سرور دارای کد وضعیت 200 است.

در بخش Scripts و قسمت Post-response کد زیر را وارد کنید:

pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});

برای بررسی وجود یک شناسه در پاسخ JSON نیز می‌توانید از کد زیر استفاده کنید:

pm.test("Response has a user id", function () {
    const data = pm.response.json();
    pm.expect(data.id).to.exist;
});

پس از ارسال درخواست، نتیجه تست‌ها در بخش Test Results نمایش داده می‌شود.

پروژه عملی: ورود کاربر و دریافت اطلاعات با Bearer Token

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

منبع : مستندات احراز هویت DummyJSON

مرحله اول: ارسال درخواست ورود

یک درخواست جدید در Postman ایجاد کنید.

متد را روی POST قرار دهید و آدرس زیر را وارد کنید:

https://dummyjson.com/auth/login

در بخش Body گزینه raw و نوع JSON را انتخاب کنید و اطلاعات زیر را وارد کنید:

{
  "username": "emilys",
  "password": "emilyspass",
  "expiresInMins": 30
}

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

مرحله دوم: ذخیره توکن در Environment

برای اینکه مجبور نباشید توکن را در هر درخواست به‌صورت دستی وارد کنید، می‌توانید آن را در متغیر Environment ذخیره کنید.

در بخش Scripts و قسمت Post-response کد زیر را قرار دهید:

const data = pm.response.json();

pm.test("Login successful", function () {
    pm.response.to.have.status(200);
    pm.expect(data.accessToken).to.exist;
});

pm.environment.set("accessToken", data.accessToken);

پس از اجرای درخواست، اگر ورود موفق باشد، توکن در متغیر accessToken ذخیره می‌شود.

مرحله سوم: دریافت اطلاعات کاربر

اکنون یک درخواست جدید ایجاد کنید.

متد را روی GET قرار دهید و آدرس زیر را وارد کنید:

https://dummyjson.com/auth/me

به بخش Authorization بروید و گزینه Bearer Token را انتخاب کنید.

در قسمت Token مقدار زیر را قرار دهید:

{{accessToken}}

حالا درخواست را ارسال کنید.

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

مرحله چهارم: بررسی نتیجه با تست خودکار

برای اطمینان از دریافت اطلاعات صحیح، کد زیر را در بخش Post-response وارد کنید:

pm.test("User information received", function () {
    pm.response.to.have.status(200);
});
https://learning.postman.com/docs/tests-and-scripts/write-scripts/test-scripts?utm_source=chatgpt.com
pm.test("Username is correct", function () {
    const data = pm.response.json();
    pm.expect(data.username).to.equal("emilys");
});

با اجرای درخواست، Postman کد وضعیت و نام کاربری دریافتی را بررسی می‌کند.

به این ترتیب، یک فرایند ساده شامل ورود، دریافت توکن، احراز هویت و دریافت اطلاعات کاربر را با Postman آزمایش کرده‌اید.

خطاهای رایج هنگام تست API با Postman

هنگام تست API با Postman ممکن است با خطاهای مختلفی روبه‌رو شوید. شناخت این خطاها به پیدا کردن سریع‌تر مشکل کمک می‌کند.

نکته مهم اینکه خطای CORS معمولاً محدودیتی در مرورگرهاست و نباید آن را با خطای عمومی Postman یکسان دانست. Postman دسکتاپ و مرورگر ممکن است در نحوه مواجهه با این محدودیت تفاوت داشته باشند.

نکات امنیتی هنگام کار با Postman

هنگام کار با APIهایی که به اطلاعات حساس دسترسی دارند، رعایت نکات امنیتی ضروری است.

• توکن‌ها و کلیدهای API را در اختیار افراد دیگر قرار ندهید.
• اطلاعات ورود واقعی را در Collectionهای عمومی ذخیره نکنید.
• برای ارتباط با APIهای حساس از HTTPS استفاده کنید.
• دسترسی‌های غیرضروری را برای کلیدها و توکن‌ها فعال نکنید.
• هنگام اشتراک‌گذاری درخواست‌ها، اطلاعات محرمانه را حذف یا مخفی کنید.
• از متغیرهای امن و تنظیمات مناسب برای مدیریت اطلاعات حساس استفاده کنید.

سؤالات متداول درمورد postman

_Postman برای چه کاری استفاده می‌شود؟

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

_آیا برای استفاده از Postman باید برنامه‌نویسی بلد باشیم؟

برای ارسال درخواست‌های ساده و بررسی پاسخ‌ها نیازی به دانش برنامه‌نویسی پیشرفته ندارید؛ اما برای نوشتن تست‌های خودکار و اسکریپت‌ها، آشنایی مقدماتی با JavaScript مفید است.

_تفاوت GET و POST در Postman چیست؟

GET برای دریافت اطلاعات از سرور استفاده می‌شود؛ درحالی‌که POST معمولاً برای ارسال داده یا ایجاد یک منبع جدید کاربرد دارد.

_Bearer Token در Postman چیست؟

Bearer Token نوعی روش احراز هویت است که در آن یک توکن دسترسی در هدر Authorization ارسال می‌شود تا API بتواند درخواست‌کننده را شناسایی و مجازبودن دسترسی او را بررسی کند.

_آیا Postman از تست خودکار API پشتیبانی می‌کند؟

بله. با استفاده از JavaScript و امکانات بخش Scripts می‌توانید شرایطی مانند کد وضعیت، وجود فیلدهای موردنظر و مقادیر پاسخ را به‌صورت خودکار بررسی کنید.

_Collection در Postman چه کاربردی دارد؟

Collection برای ذخیره و دسته‌بندی درخواست‌های مرتبط استفاده می‌شود و مدیریت و اجرای مجموعه‌ای از درخواست‌های API را آسان‌تر می‌کند.

جمع‌بندی

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

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