Postman چیست و آموزش نحوه استفاده از آن

آشنایی کامل با Postman

0 700

Postman چیست؟

Postman یک ابزار تست مقیاس­ پذیر API است که به سرعت در پایپ­ لاین ­های CI/CD ادغام می­شود. این ابزار در سال ۲۰۱۲ به عنوان یک پروژه­ ی جانبی توسط Abhinav Asthana به منظور تسهیل جریان کار در تست و توسعه ­ی API آغاز شد. API به اپلیکیشن­ های نرم ­افزاری اجازه ­ی ارتباط با یکدیگر از طریق تماس­های API را می­دهد.

در این مقاله­ ی آموزشی موارد زیر را فراخواهید گرفت:

چرا از Postman استفاده کنید؟

امروزه با بیش از ۱۰ میلیون کاربر، Postman به دلایل زیر ابزار انتخابی کاربران شده است:

  • قابلیت دسترسی – برای استفاده از Postman فقط کافی است به اکانت خود وارد شوید. این ابزار دسترسی به فایل­ها را در هر زمان و هر مکانی که یک اپلیکیشن Postman روی کامپیوتر نصب باشد آسان می­سازد.
  • استفاده از کلکسیون ­ها – Postman به کاربران برای تماس­های APIهای خود اجازه ­ی ساخت کلکسیون­ها را می­دهد. هر کلکسیون میتواند زیرپوشه­ ها و درخواست­ های متعددی ایجاد نماید. این در سازماندهی مجموعه­ هایتان به شما کمک می­کند.
  • همکاری – کلکسیون­ ها و محیط ها می­توانند وارد یا صادر شوند که این ویژگی باعث تسهیل در اشتراک ­گذاری فایل­ها می­گردد. همچنین یک لینک مستقیم می­تواند برای به اشتراک گذاشتن کلکسیون­ها مورد استفاده قرار گیرد.
  • ایجاد محیط – داشتن محیط­های متعدد در تکرار کمتر تست ها کمک می­کند بدین گونه که از یک کلکسیون مشابه میتوان در محیط های متفاوت استفاده کرد. این همان جایی است که پارامتری کردن صورت خواهد گرفت و در ادامه ی آموزش به بحث راجع به آن خواهیم پرداخت.
  • ایجاد تست ها – نقاط بررسی تست ها مانند تایید برای وضعیت موفقیت آمیز پاسخ HTTP می­توانند به تمام تماس­های API که به اطمینان از پوشش تست کمک می­کند، اضافه شوند.
  • تست اتوماسیون – با استفاده از Collection Runner یا Newman، تست ها می­توانند در تکرارهای مختلف انجام شوند تا باعث صرفه جویی در زمان برای تست­ های تکراری گردد.
  • عیب یابی – کنسول Postman به بررسی داده هایی که بازیابی شده اند کمک می­کند و این، تسهیل در عیب یابی تست ها را به ارمغان می آورد.
  • ادغام مداوم – با توانایی آن در پشتیبانی از ادغام مداوم، اعمال توسعه حفظ می­شود.

 

نحوه­ ی دانلود و نصب Postman

با استفاده از یک ابزار Open Source، Postman به راحتی قابل دانلود است. در اینجا مراحل نصب آن آورده شده است:

گام ۱) به آدرس https://www.postman.com/downloads/ رفته و پلتفرم مورد نظر خود را از بین Mac، Windows یا Linux انتخاب نمایید. روی Download کلیک کنید.

گام۲) حالا پیام Your download is in progress باید در صفحه ی برنامه ها نمایش داده شود. پس از کامل شدن دانلود روی Run کلیک کنید.

گام ۳) نصب آغاز می­شود.

گام ۴) در پنجره ی بعدی، برای اکانت Postman ثبت نام کنید.

نکته: توجه کنید که به دو روش می­توان برای اکانت Postman ثبت نام کرد. یکی ایجاد یک حساب کاربری خود Postman است و دیگری استفاده از حساب Google می­باشد. اگرچه Postman به کاربران اجازه ی استفاده از ابزار بدون ورود را می­دهد، اما ثبت نام تضمین می­کند که کلکسیون شما ذخیره شده و امکان دسترسی برای استفاده های بعدی را داشته باشید.

گام ۵) ابزارهای محیط کاری مورد نیازتان را انتخاب کرده و روی Save My Preferences کلیک نمایید.

گام ۶) صفحه ی راه اندازی را مشاهده خواهید کرد.

نحوه­ ی استفاده از Postman

در زیر محیط کاری Postman را مشاهده می­کنید. بیایید ویژگی های مختلف این ابزار را کشف کنیم!نحوه­ ی استفاده از Postman

  1. New – اینجا جایی است که یک درخواست، کلکسیون یا محیط جدید میخواهید بسازید.
  2. Import – از این دکمه برای وارد کردن یک کلکسیون یا محیط استفاده می­شود. گزینه هایی همچون وارد کردن از طریق فایل، پوشه، لینک یا paste کردن متن خام وجود دارد.
  3. Runner – تست های اتوماسیون از طریق Collection Runner قابل اجرا هستند. که در بحث های بعدی بیشتر به آن پرداخته خواهدشد.
  4. Open New – با کلیک کردن روی این دکمه، یک tab جدید، پنجره ی Postman یا Runner جدید باز کنید.
  5. My Workspace – شما می­توانید یک محیط کاری جدید شخصی یا تیمی بسازید.
  6. Invite – با دعوت از اعضای تیم در یک محیط کاری همکاری کنید.
  7. History – درخواست­های گذشته که ارسال کرده اید در History نشان داده خواهد شد. این ردیابی فعالیت هایی که انجام داده اید را آسان می­کند.
  8. Collections – با استفاده از Collection ها مجموعه ی تست هایتان را سازمان­دهی کنید. هر کلکسیون می­تواند شامل زیرپوشه ها و درخواست های متعددی باشد. همچنین یک درخواست یا پوشه قابلیت کپی شدن دارد.
  9. Request tab – این قسمت عنوان درخواست­هایی که شما در حال کار روی آن هستید را نمایش می­دهد. به طور پیش­فرض Untitled Request برای درخواست­های بدون عنوان نشان داده خواهدشد.
  10. HTTP Request – با کلیک روی آن یک لیست از درخواست­های مختلف مانند GET، POST، COPY، DELETE و غیره نمایش داده میشود. در تست، متداول ترین درخواست­های استفاده شده GET و POST هستند.
  11. Request URL – به عنوان یک نقطه ی پایانی شناخته می­شود، در این قسمت لینک با جایی که API با آن در ارتباط است را مشخص می­کنید.
  12. Save – در صورت ایجاد تغییرات در درخواست، کلیک کردن روی save برای از دست نرفتن یا بازنویسی تغییرات ضروری است.
  13. Params – در اینجا پارامترهای مورد نیاز برای یک درخواست مانند مقادیر اصلی را بنویسید.
  14. Authprization – به منظور دسترسی به APIها، مجوز مناسب لازم است. آن ممکن است به شکل نام کاربری و رمز عبور، توکن حامل و غیره باشد.
  15. Headers – بسته به نیازهای سازمان می­توانید هدرهایی مانند نوع محتوای JSON تنظیم کنید.
  16. Body – در این قسمت می­توان جزئیات درخواستی را که معمولا در درخواست POST استفاده می­شود را شخصی سازی کرد.
  17. Pre-request Script – این­ها اسکریپت هایی هستند که قبل از درخواست اجرا خواهند شد. معمولا، Pre-request scriptها برای محیط تنظیم شده استفاده می­شوند تا اطمینان حاصل کنند که تست­ها در محیط درستی به اجرا درخواهند آمد.
  18. Tests – تست­ها اسکریپت هایی هستند که در طول درخواست اجرا می­شوند. داشتن تست­ها به علت تنظیم نقاط بررسی برای تایید صحت وضعیت پاسخ، داده­ های بازیابی شده (همانطور که انتظار می­رود) و سایر تست­ها مهم است.

آموزش کامل postman (کار با درخواست­های GET)

درخواست­های GET برای بازیابی اطلاعات از URL داده شده استفاده میشوند. هیچ تغییری روی نقطه­ی پایانی اعمال نخواهدشد.

در این مقاله ی آموزشی از URL زیر برای تمام مثال­ها استفاده خواهیم کرد.

https://jsonplaceholder.typicode.com/users

در محیط کاری

  1. درخواست HTTP خود را روی GET تنظیم نمایید.
  2. در فیلد URL درخواست، لینک را وارد کنید.
  3. روی Send کلیک کنید.
  4. پیام ۲۰۰ OK را مشاهده خواهید کرد.
  5. در بدنه باید ۱۰ نتیجه ی کاربر وجود داشته باشد که نشان می­دهد تست شما با موفقیت اجرا شده است.نحوه­ ی استفاده از Postman

نکته: در مواردی ممکن است درخواست Get ناموفق باشد. این میتواند به دلیل یک URL درخواست نامعتبر یا نیاز به احراز هویت باشد.

 

کار با درخواست­های POST

درخواست­های Post از درخواست­های Get متفاوت است زیرا کاربر با افزودن داده ها به نقطه ی پایانی، آن­ها را دستکاری می­کند. با استفاده از همان داده ها از آموزش قبلی در درخواست Get، می­خواهیم کاربر خودمان را اضافه کنیم.

گام ۱) برای ایجاد یک درخواست جدید روی new tab کلیک کنید.نحوه­ ی استفاده از Postman

گام ۲) در tab جدید

  1. درخواست HTTP خود را روی POST تنظیم نمایید.
  2. همان لینک را در url درخواست وارد کنید: https://jsonplaceholder.typicode.com/users
  3. به تب Body سوییچ کنید.

نحوه­ ی استفاده از Postman

گام ۳) در بدنه،

  1. روی raw کلیک کنید.
  2. JSON را انتخاب نمایید.نحوه­ ی استفاده از Postman

 

گام ۴) فقط نتیجه ی یک کاربر را از درخواست get قبلی مانند زیر copy & paste کنید. اطمینان حاصل کنید که کدها به طور صحیح با بندها و براکت­های برابر کپی شده باشد. Id را به ۱۱ تغییر داده و به نام دلخواه خود نام­گذاری نمایید. همچنین می­توانید سایر جزئیات مانند آدرس را تغییر دهید.

آموزش کامل postman

آموزش کامل postman

نکته: درخواست Post باید فرمت صحیحی داشته باشد تا اطمینان حاصل شود که داده های درخواست شده ایجاد خواهد شد. این روش خوبی برای استفاده از Get است که فرمت JSON درخواست را بررسی نماید. شما می­توانید از ابزارهایی مانند https://jsonformatter.curiousconcept.com استفاده کنید.

آموزش کامل postman

گام ۵) Next،

  1. روی Send کلیک کنید.
  2. Status:201 created نمایش داده خواهد شد.
  3. داده های پست شده در بدنه نشان داده می­شود.

آموزش کامل postman

نحوه ­ی پارامتری کردن درخواست ها

پارامتری کردن داده ها یکی از مفیدترین ویژگی­ های Postman است. به جای ایجاد درخواست های یکسان با داده ­های متفاوت، شما میتوانید از متغیرها به همراه پارامتر استفاده کنید. این داده ها می­تواند از فایل دیتا یا متغیر محیط باشد. پارامتری کردن باعث جلوگیری از تکرار تست­های یکسان می­شود و از این تکرر می­توان برای تست اتوماسیون استفاده کرد. پارامترها با استفاده از آکلاد­های دوبل ساخته می­شوند: {{نمونه}} به نمونه­ای از استفاده ی پارامترها در درخواست قبلی نگاهی بیندازید:

در این قسمت به آموزش ایجاد یک درخواست get پارامتری­شده می­پردازیم.

گام ۱)

  1. درخواست HTTP خود را روی GET تنظیم نمایید.
  2. این لینک را وارد کرده: http://jsonplaceholder.typicode.com/users و قسمت اول لینک را با پارامتری مانند {{url}} جایگزین نمایید. url درخواست باید به صورت {{url}}/users باشد.
  3. روی Send کلیک کنید.

هیچ پاسخی نباید نشان داده شود چون منبعی برای پارامترمان تنظیم نکرده ایم.

تست api با postman

گام ۲) برای استفاده از پارامتر باید محیط را تنظیم کنید.

  1. روی آیکون چشم کلیک نمایید.
  2. برای تنظیم پارامتر در محیط global که می­تواند در تمام کلکسیون ها استفاده شود، روی edit کلیک کنید.

تست api با postman

گام ۳) در متغیر،

  1. نام را روی (url (https://jsonplaceholder.typicode.com تنظیم کنید.
  2. روی Save کلیک نمایید.

تست api با postman

گام ۴) اگر صفحه­ ی بعدی را مشاهده کردید روی close کلیک نمایید.

تست api با postman

گام ۵) به درخواست Get برگشته و روی send کلیک کنید. حالا باید نتایج برای درخواست شما نشان داده شده باشد.

تست api با postman

نکته: برای جلوگیری از ارورها همیشه اطمینان حاصل کنید که پارامترهایتان منبعی مانند متغیر محیط یا فایل دیتا داشته باشند.

 

نحوه­ ی ایجاد تست­های Postman

تست­های Postman کدهای جاوا اسکریپتی هستند که به درخواست­ها اضافه می­شوند تا برای تایید نتایج مانند وضعیت موفق یا ناموفق، مقایسه ی نتایج قابل انتظار و غیره به شما کمک کند. آن معمولا با pm.test شروع می­شود. از این تست­ها می­توان در مقایسه برای اثبات و تایید دسترسی فرمان ها در سایر ابزارها استفاده کرد.

حال می­خواهیم چند تست اساسی برای درخواست­های پارامتری­ قبلی­مان ایجاد نماییم.

گام ۱) به درخواست کاربری GET خود از آموزش­های پیشین بروید.

  1. روی تب Tests سوییچ کنید. در سمت راست کدهای snippet نشان داده میشود.
  2. از بخش snippets، روی Status code: Code is 200 کلیک نمایید.

گام ۲) روی Send کلیک کنید. نتیجه ی تست نشان داده خواهدشد.

گام ۳) به تب Test برگشته و تست دیگری اضافه کنید. این بار ما نتیجه ی قابل انتظار را با نتیجه ی واقعی مقایسه خواهیم کرد.

از بخش snippets، روی Response body: JSON value check کلیک کنید. در اینجا ما بررسی خواهیم کرد که Leanne Graham شناسه کاربری ۱ را دارد یا خیر؟!

گام ۴)

  1. نام تست خود را از کد با “Check if user with id1 id1 is Leanne Graham” جایگزین کنید تا نام تست آن­چه را که دقیقا میخواهیم تست کنیم، مشخص کند.
  2. value را با jsonData[0].name جایگزین نمایید. برای گرفتن مسیر، بدنه را در نتیجه ی Get بررسی کنید. از آنجا که Leanne Graham شناسه کاربری ۱ است، jsonData در اولین نتیجه ای است که باید با ۰ شروع شود. اگر میخواهید نتیجه ی دوم را دریافت کنید، از jsonData[1] استفاده کرده و برای بقیه ی نتایج به همین ترتیب عمل نمایید.

گام ۵) روی send کلیک کنید. الان باید دو نتیجه ی تست قبولی برای درخواستتان وجود داشته باشد.

نکته: انواع مختلفی از تست­هایی که می­توانند در Postman ایجاد شوند، وجود دارد. سعی کنید این ابزار را کشف کرده و ببینید کدام تست ها متناسب با نیاز شما است.

 

نحوه ­ی ایجاد کلکسیون ها

کلکسیون­ها نقش مهمی در سازمان­دهی به مجوعه ­های تست بازی می­کنند. آن می­تواند با وارد کردن و صادر کردن کلکسیون­ها اشتراک گذاری آن­ها را بین اعضای تیم آسان نماید. در این مقاله ی آموزشی، چگونگی ایجاد و اجرای کلکسیون­ها را خواهیم آموخت.

برای ایجاد یک کلکسیون مراحل زیر را طی کنید:

گام ۱) روی دکمه ی New  در گوشه­ی بالا سمت چپ صفحه کلیک نمایید.

گام ۲) Collection را انتخاب کنید. پنجره ی ایجاد کلکسیون  باید ظاهر شود.

گام ۳) نام و توضیحات کلکسیون موردنظر خود را وارد کرده و روی Create کلیک نمایید. بدین ترتیب یک کلکسیون ساخته خواهدشد.

گام ۴) به درخواست Get قبلی برگشته و روی Save کلیک کنید.

گام ۵)

  1. Postman Test Collection را انتخاب نمایید.
  2. روی Save to Postman Test Collection کلیک کنید.

گام ۶) Postman test collection حالا باید شامل یک درخواست باشد.

گام ۷) گام­های ۴ و ۵ را برای درخواست Post قبلی تکرار کنید تا collection دارای دو درخواست باشد.

نحوه­ ی اجرای کلکسیون­ها با استفاده از Collection Runner

دو راه برای اجرای کلکسیون وجود دارد که عبارتند از: Collection Runner و Newman. ما با اجرا در Collection Runner شروع می­کنیم.

گام ۱) روی دکمه ی  Runner که در بالای صفحه کنار Import قرار دارد کلیک نمایید.

نحوه­ ی اجرای کلکسیون­ها با استفاده از Collection Runner

گام ۲) صفحه­ ی Collection Runner مانند زیر نمایش داده خواهدشد. در زیر توضیحات فیلد­های مختلف آورده شده است.

نحوه­ ی اجرای کلکسیون­ها با استفاده از Collection Runner

گام ۳) Postman Test Collection خود را با تنظیم موارد زیر اجرا کنید:

  • Postman test collection را انتخاب نمایید- تعداد تکرارها را روی ۳ تنظیم کنید.
  • تاخیر را روی ۲۵۰۰ میلی ثانیه تنظیم نمایید.
  • روی دکمه ی Run Postman Test… کلیک کنید.

نحوه­ ی اجرای کلکسیون­ها با استفاده از Collection Runner

گام ۴) صفحه­ ی Run Results بعد از کلیک بر روی دکمه ی  Run نمایش داده خواهدشد. بسته به تاخیر، شما تست­ها را حین اجرای آن­ها باید ببینید.

  1. پس از پایان تست­ها، می­توانید وضعیت تست را که موردقبول واقع شده یا خیر و همچنین نتایج هر تکرار را مشاهده کنید.
  2. وضعیت قابل قبول را در درخواست Get میبینید.
  3. از آنجایی که هیچ تستی برای Post نداشتیم، باید پیغامی مبتنی بر The request did not have any tests نمایش داده شود.

نحوه­ ی اجرای کلکسیون­ها با استفاده از Collection Runner

میبینید که چقدر مهم است در درخواست­هایتان تست­هایی وجود داشته باشد تا در صورت موفقیت و ایجاد یا بازیابی داده­ها بتوانید وضعیت درخواست HTTP را تایید کنید.

میتوانید در این مقاله دیگر ابزارهای تست api را ببینید.

 

نحوه­ ی اجرای کلکسیون­ها با استفاده از Newman

راه دیگر اجرای یک کلکسیون از طریق Newman است. تفاوت های اصلی Neaman و Collection Runner در زیر آمده است:

  1. Newman یک افزونه برای Postman است. شما باید آن را جدا از برنامه ی اصلی آن نصب کنید.
  2. Newman از خط فرمان استفاده می­کند در حالیکه Collection Runner دارای رابط کاربری گرافیکی (GUI) است.
  3. از Newman می توان برای ادغام مداوم استفاده کرد.

برای نصب Newman و اجرای کلکسیون از طریق آن، طبق مراحل زیر عمل نمایید:

گام ۱) با استفاده از این لینک nodejs را نصب کنید: http://nodejs.org/download/

گام ۲) خط فرمان را باز کرده و این عبارت را وارد نمایید.

تست وب سرویس با postman

حالا Newman باید روی کامپیوتر شما نصب شده باشد.

تست وب سرویس با postman

گام ۳) پس از نصب Newman، به محیط کاری Postman برگردید. در قسمت Collection، روی سه نقطه کلیک کنید. پس از ظاهر شدن آپشن ها، گزینه ی Export را انتخاب نمایید.

تست وب سرویس با postman

گام ۴) در قسمت Export Collection گزینه ی توصیه شده ی Collection v2.1 را انتخاب کرده و سپس روی Export کلیک نمایید.

تست وب سرویس با postman

گام ۵) لوکیشن مورد نظر خود را انتخاب نموده و روی Save کلیک کنید. توصیه می­شود یک پوشه ی خاص برای تست­های Postman خود بسازید. یک کلکسیون در فهرست محلی انتخاب شده ی شما export می­شود.

گام ۶) همچنین باید محیطمان را نیز export کنیم. روی آیکون چشم کنار لیست کشویی محیط در Global کلیک و Download as JSON را انتخاب نمایید. لوکیشن موردنظر خود را انتخاب کرده و سپس روی Save کلیک کنید. توصیه می­شود که محیط در همان پوشه ی کلکسیونتان باشد.

 postman

گام ۷) محیط باید در همان فهرست محلی در Collection، export شده باشد.

گام ۸) حالا به خط فرمان برگشته و فهرست را به جایی که کلکسیون و محیط را در آن ذخیره کرده اید تغییر دهید.

 postman

گام ۹) با استفاده از فرمان زیر کلکسیون خود را اجرا کنید:

 postman

نتایج اجرا مانند زیر ظاهر خواهد شد.


 postman

برخی کدهای اساسی Newman برای اجرا در زیر آمده است:

  1. اجرای فقط یک کلکسیون. این می­تواند در صورت عدم وابستگی به محیط یا فایل دیتای تست مورد استفاده قرار گیرد.

  1. اجرای یک کلکسیون و محیط. نشانه­گر -e برای محیط است.

  1. اجرای یک کلکسیون با تعداد تکرار مورد نظر.

  1. اجرا با فایل دیتا.

  1. تنظیم زمان تاخیر. این نکته­ بسیار مهم است؛ چون اگر آن بدون تاخیر اجرا گردد سبب می­شود درخواست­ها بدون اینکه درخواست قبلی در سرور نهایی تکمیل شده باشد، شروع شده و این ممکن است منجر به عدم موفقیت تست­ها گردد.

 

خلاصه

  • در حال حاضر Postman یکی از محبوب ترین ابزارهای مورد استفاده در تست API است.
  • قابلیت دسترسی، استفاده از کلکسیون­ها، همکاری و ادغام مداوم ویژگی­های اصلی در یادگیری Postman هستند.
  • توصیه می­شود یک حساب کاربری در Postman ایجاد کنید تا کلکسیون هایتان به صورت آنلاین قابل دسترس باشند.
  • میتوانید درخواست­ها را در Postman پارامتری کنید.
  • امکان ایجاد تست­ها برای تایید درخواست Postman وجود دارد.
  • کلکسیون­ها از دو طریق Newman و Collection Runner قابل اجرا هستند.

منبع: https://www.guru99.com/postman-tutorial.html

ارسال یک پاسخ

آدرس ایمیل شما منتشر نخواهد شد.