نحوه استفاده از Postman برای تست یک API

رابط های برنامه نویسی کاربردی (API) نقش اساسی در توسعه نرم افزار دارند. اگر قصد توسعه یک برنامه یا وب سایت آنلاین را دارید، باید یک API ایجاد کنید، از یک موجود یا هر دو استفاده کنید.

رابط های برنامه نویسی کاربردی (API) نقش اساسی در توسعه نرم افزار دارند. اگر قصد توسعه یک برنامه یا وب سایت آنلاین را دارید، باید یک API ایجاد کنید، از یک موجود یا هر دو استفاده کنید.

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

پستچی چیست؟

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

Postman به شما امکان می دهد تمام جنبه های گردش کار توسعه API را مدیریت کنید. این پلتفرم همه چیزهایی را که برای آزمایش یک CRUD API کامل نیاز دارید فراهم می کند. برخی از ویژگی های محبوب Postman عبارتند از:

• مشخصات
• مستندات
• دستور العمل های گردش کار
• تست کردن
• معیارها

نصب پستچی در دستگاه شما

می‌توانید Postman را از وب‌سایت رسمی آن در دستگاه‌های Windows، Apple یا Linux دانلود کنید. با انتخاب نوع دستگاه، دانلود خودکار یک فایل اجرایی شروع می شود. این پلت فرم Postman را در چند مرحله آسان نصب می کند.

نحوه ایجاد درخواست با استفاده از Postman

آخرین نسخه پلتفرم Postman (v9.28.1) با رابط کاربری زیر راه اندازی می شود:

برای ارسال درخواست به یک API موجود، روی دکمه جدید در گوشه سمت چپ بالای رابط Postman کلیک کنید. این شما را به پنجره پاپ آپ زیر هدایت می کند:

گوشه سمت چپ بالای پنجره پاپ آپ دارای گزینه ای برای ایجاد یک درخواست اولیه HTTP است. با انتخاب آن گزینه به رابط زیر می روید:

چندین فیلد مهم در رابط درخواست وجود دارد. اولین فیلدی که باید به آن توجه کنید فیلد روش درخواست (یا فعل) است. روش درخواست پیش فرض GET است، اما بیش از 10 روش مختلف برای انتخاب وجود دارد.

پنج روشی که به طور مرتب از آنها استفاده خواهید کرد عبارتند از:

• GET: داده ها را از پایگاه داده به دست می آورد.
• POST: داده های جدیدی را به پایگاه داده اضافه می کند.
• PUT: کل فیلد داده را در یک پایگاه داده به روز می کند.
• PATCH: جنبه های خاصی از یک فیلد داده را در یک پایگاه داده به روز می کند.
• DELETE: داده ها را از پایگاه داده حذف می کند.

فیلد URL مستقیماً در کنار فیلد روش درخواست قرار دارد. برای آزمایش یک API، شما به سادگی روش درخواست را انتخاب کرده و URL مناسب را ارائه می دهید.

تست یک API عمومی در Postman

در این بخش می توانید از هر API عمومی استفاده کنید. مثال زیر از یک API خبری به نام Newsdata.io استفاده می کند. این API چندین گزینه پرس و جو دارد که اخبار جهانی را برمی گرداند. نقطه پایانی مبتنی بر کشور این ساختار را دارد:

https://newsdata.io/api/1/news?apikey=YOUR_API_KEY&country=us

شما باید مقدار YOUR_API_Key را در URL با کلید API که پس از ثبت نام در Newsdata.io دریافت خواهید کرد، جایگزین کنید. درج URL به روز شده در Postman خروجی مشابهی را به شکل زیر برمی گرداند.

{
    "status": "success",
    "totalResults": 10173,
    "results": [
        {
            "title": "Apple could be the first to use TSMC's 3nm chip process for M2 Pro",
            "link": "https://appleinsider.com/articles/22/08/18/apple-could-be-the-first-to-use-tsmcs-3nm-chip-process-for-m2-pro?utm_medium=rss",
            "keywords": null,
            "creator": [
                "news@appleinsider.com (Mike Peterson)"
            ],
            "video_url": null,
            "description": "Apple's 2022 MacBook Pros may pack new M2 Pro and M2 Max chipsets made with TSMC's latest 3nm manufacturing process, according to a new report.M2TSMC, the world's largest semiconductor contract manufacturer, has been steadily building out its 3nm production processes. According to the Commercial Times, Apple could be the first customer to get its hands on those chips. Read more...",
            "content": null,
            "pubDate": "2022-08-18 15:22:53",
            "image_url": null,
            "source_id": "appleinsider",
            "country": [
                "united states of america",
                "united kingdom",
                "india",
                "australia",
                "singapore",
                "canada"
            ],
            "category": [
                "technology"
            ],
            "language": "english"
        },
    ],
    "nextPage": 1
}

پستچی مجموعه ای از اخبار را برمی گرداند. خروجی بالا فقط یک نمونه از این اخبار را نشان می دهد.

اکنون می توانید API ها را با Postman آزمایش کنید

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

هنگامی که API های خود را آزمایش کردید، گام منطقی بعدی این است که آنها را در برنامه های خود ادغام کنید.

منبع مقاله