بسم الله الرحمن الرحیم

آموزش برنامه نویسی در مجموعه ABLY

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Postman چیست؟

آموزش Postman

تست سریع و آسان Web API با استفاه از Postman

بسم الله الرحمن الرحیم

Postman چیست؟

آموزش Postman

تست سریع و آسان Web API با استفاه از Postman

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -- 

آموزش برنامه نویسی در مجموعه ABLY

Postman چیست؟

Postman یک افزونه گوگل کروم است که با استفاده از آن میشود براحتی متد های یک Web API را اجرا، تست یا بررسی کرد.

این ابزار به ما کمک میکند تا به سرعت یک درخواست HTTP ایجاد و ارسال کنیم.

ذخیره درخواست ها برای استفاده های بعدی، تجزیه و تحلیل پاسخ ها، تغییر سریع محتوای یک درخواست، احراز هویت کاربر با ارسال اطلاعات، سفارشی کردن و... از امکانات خوب این افزونه است که باعث میشود در هنگام توسعه یک API زمان بسیار زیادی را صرفه جویی کنید.

پست‌من در ارتباط با برنامه هایی مانند Azure بسیار مفید است.

Postman ابزاری بسیار سبک بر مبنای وب است که از آن برای تست کردن سایر API ها استفاده می شود. کاربرد این ابزار زمانی مشهود است که برنامه نویس قبل از استفاده از یک مدل API آنرا با Postman بررسی کند. درخواست های API (حتی درخواست های پیچیده) را می توان با Postman به راحتی ایجاد کرد و جواب آنها را به شکل ها و فرمت های مختلف در مرورگر دریافت نمود. همین کارایی باعث می شود که برنامه نویس بداند که API مورد نظرش چگونه رفتار می کند و برنامه نویس در تصمیم گیری برای استفاده از آن راحت تر باشد.

دلیل استفاده از Postman

• رایگان

این کلاینت را می توانید به صورت رایگان برای سیستم عامل های مختلف دانلود و نصب نمایید.

• به اشتراک گذاری آسان

در Postman با داشتن مفهومی به نام Collection تمامی API ها دسته بندی می شوند و به راحتی می توان آنها را Import/Export کرد در نتیجه هرکس که لازم باشد از این API ها استفاده کند یا آنها را برای دیگران ارسال کند به راحتی می تواند از این قابلیت استفاده نماید.

• خروجی کد برای هر یک از API ها

هر چیزی که بتواند زمان برنامه نویسی و توسعه را کم کند بسیار اهمیت پیدا می کند. یکی از این قابلیتها همین Code Snippet است که می توانید پس از مقدار دهی و تست هر یک از API ها می توایند یک خروجی به زبان برنامه نویسی مورد علاقه خود داشته باشد. زبانهایی مانند JAVA، C#، PHP، Python و…

• یکبار بنویسید و در همه جا استفاده کنید

به راحتی می توانید با ثبت نام در وب سایت برای خودتان یک اکانت بسازید. تمامی Collection  ها و  API را می توانید با این اکانت خود Sync نمایید و از این به بعد هر جایی که آنها را لازم داشتید می توانید استفاده نمایید. معمولاً این اتفاق به صورت اتوماتیک رخ می دهد، البته اگر ثبت نام کرده باشید و در این نرم افزار لاگین کرده باشید. اما برای اینکه دستی این کار را انجام دهید می توانید از دکمه ای که در کنار نام کاربری شما در بالای صفحه وجود دارد استفاده نمایید.

آموزش Postman

استفاده از Postman راحت است. ابتدا برنامه را نصب و اجرا کنید.

در تصویر بالا دو تب به نام های history و collection وجود دارد.

تب history تاریخچه تمام چیزهایی که ارسال کرده اید را نشان میدهد و اگر بخواهید آن ها را ذخیره کنید در تب collection قرار می گیرند. از collection میتوانید export بگیرید و به عنوان یک backup نگهداریش کنید.

در بالای همین قسمت دو بخش دیگر با نام های runner و import وجود دارد که runner تمام درخواست های یک مجموعه (collection) را به صورت گروهی اجرا میکند که امکان import درخواست ها و همچنین export نتایج وجود دارد. هدف این بخش اجرا و تست یک مجموعه است.

بخش import نیز همانطور که از نامش پیداست امکان اضافه کردن اطلاعات رو به شما میدهد. این اطلاعات میتواند collection, environment, data dump, curl command یا یک RAML / WADL / swagger (v1/v2) / runscope باشد.

Swagger چیست؟

Swagger اجازه میدهد یک ساختار توصیفی از API خودتان بسازید و به این دلیل مفید است چون میتوانیم به طور خودکار برای API خودمان مستندات زیبا و یک محیط تعاملی ایجاد کنیم، همچنین امکان تست API را هم برایمان فراهم میکند. swagger این کار را با خواندن به اصطلاح حاشیه ها/ یادداشت ها یا کامنت های داخل سورس انجام میدهد.

در تصویر بالا و در صفحه اصلی می توانید با افزودن تب های جدید چندین درخواست داشته باشید.

گزینه authorization انواع روش های احراز هویت را برای استفاده در اختیارتان قرار می دهد.

گزینه header نیز از نامش پیداست که چه کاری انجام میدهد. یک درخواست می تواند هدرهای مختلفی داشته باشد. برای افزودن header که به صورت key/value مشخص میشود به این بخش (header) مراجعه کنید.

در قسمت body اطلاعاتی که همراه با درخواست باید ارسال شود، قابل تعریف است.

مراحل ارسال HTTP GET request با استفاده از Postman

مراحل ارسال HTTP POST request با استفاده از Postman

اگر یک مثال کلی بخواهیم بزنیم سایت freegeoip.net را در نظر بگیرید که یک API برای دریافت اطلاعات ip به طور رایگان در دسترس همه قرار داده است. در توضیحاتش نوشته است که:

آدرس که مشخص است و فقط باید IP مورد نظر و قالب پاسخ به درخواست را جایگزین کنیم. متد را هم که GET تعریف کرده است. پس داخل postman درخواستی به صورت زیر ارسال میکنیم. ما در قسمت header که عدد 11 را نشان میدهد چیزی تعریف نکردیم و خود postman به طور خودکار header های مورد نیاز رو مشخص کرده است.