آشنایی با API Catalog در Postman

API Catalog در Postman یک داشبورد مرکزی برای پایش، تحلیل و حاکمیت APIهای سازمان است. این قابلیت داده‌هایی مثل نتایج اجرای Postman CLI، pipelineهای CI/CD و بررسی کیفیت specها را جمع می‌کند و به شکل قابل اقدام نمایش می‌دهد.

این قابلیت در پلن‌های Postman Enterprise در دسترس است. API Catalog با Agent Mode هم کار می‌کند، بنابراین می‌توانید درباره APIها سوال بپرسید و وقتی چیزی خراب است، برای رفع مشکل راهنمایی بگیرید.

برای ورود به API Catalog، از Home گزینه API Catalog را انتخاب کنید.

پیش‌نیازها #

• برای وصل کردن داده‌ها از connectorهای ابری و repositoryهای Git، به نقش Admin نیاز دارید.
• برای پیکربندی API Catalog، pin/unpin کردن scorecardها و ساخت scorecard سفارشی باید API Catalog Manager باشید.
• توسعه‌دهنده‌ها فقط workspaceهایی را می‌بینند که به آن‌ها دسترسی دارند.

داخل API Catalog چه چیزهایی هست؟ #

• Catalog list: فهرست APIها و serviceهای کشف‌شده.
• Scorecards: معیارهایی برای سنجش کیفیت، سلامت runtime، کیفیت تست و کیفیت spec.
• Governance groups: گروه‌هایی برای تعریف و اجرای قوانین روی API specها مثل OpenAPI.
• System environments: محیط‌هایی مثل production، staging و beta برای دسته‌بندی داده‌ها.

Catalog list #

API Catalog همه serviceهای کشف‌شده را نشان می‌دهد. می‌توانید فهرست APIها را filter و sort کنید، با tag مشخص کنید کدام APIها باید مدیریت شوند، owner هر API را ببینید، ارتباط APIها با هم را بررسی کنید و health metricها را دنبال کنید.

• می‌توانید viewهای سفارشی با filter و tag بسازید.
• چند نوع اطلاعات را هم‌زمان ببینید.
• سریع به viewهای مورد نیاز خود برگردید.

Scorecardها #

Scorecardها کمک می‌کنند کیفیت API را با معیارهای مختلف بسنجید. می‌توانید scorecardهای مهم را بالای نمای API Catalog pin کنید، threshold تعریف کنید و مشخص کنید چه زمانی یک API سالم، نیازمند توجه، یا critical است.

Governance groups #

Governance groupها برای ساخت و اجرای قانون روی API specها استفاده می‌شوند. مثلا می‌توانید برای APIهای عمومی یک مجموعه قانون و برای APIهای داخلی مجموعه دیگری داشته باشید. این قوانین می‌توانند در Postman app دیده شوند، توسط Postman CLI در CI pipeline اجرا شوند، release را block کنند یا warning بدهند.

System environments #

System environmentها محیط‌های واقعی شما مثل production، staging و beta هستند. با تعریف آن‌ها، Postman می‌تواند داده‌های تست و اجرا را درست‌تر گروه‌بندی کند و عملکرد هر API را در محیط‌های مختلف نشان دهد.

کشف APIها و serviceها #

API Catalog workspaceهای متصل را نشان می‌دهد. برای پر کردن catalog، workspace را به source code وصل کنید تا Postman APIهای repository را کشف و به catalog اضافه کند. این اتصال می‌تواند با cloud connector، code discovery، runtime discovery یا import دستی انجام شود.

مشاهده پروژه API #

هر project داده‌هایی را که Postman درباره یک API در توسعه، تست و production دارد نمایش می‌دهد؛ از workspace analytics و endpoint health monitoring تا CI/CD integration، spec linting، system environments و چت با Postman AI برای کمک به رفع مشکل.

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