داشبورد گزارش API Governance در Postman نشان می‌دهد API specifications در Spec Hub تا چه حد با governance rules شما هماهنگ هستند. این قابلیت برای پلن‌های Enterprise در دسترس است و برای نقش‌های Super Admin و API Governance Manager کاربرد اصلی دارد.
کاربرد گزارش API Governance
با این گزارش می‌توانید ببینید کدام specifications قوانین governance را نقض کرده‌اند، کدام rules بیشترین violations را دارند، و وضعیت کلی conformance در تیم چگونه است. این اطلاعات به تیم کمک می‌کند مشکل‌های طراحی API را زودتر پیدا کند و روی قانون‌های پرتکرار تمرکز کند.
دسترسی به report dashboard
- به صفحه اصلی Postman بروید.
- در پنل اطلاعات تیم روی API Catalog کلیک کنید.
- گزینه Governance Groups را باز کنید.
- تب Reports را انتخاب کنید.
فیلتر کردن با Governance Groups
به‌صورت پیش‌فرض، dashboard معیارهای public workspaces و internal workspaces قابل دسترس برای همه اعضای تیم را در governance group با نام All Workspaces نشان می‌دهد. برای دیدن گروه‌های مشخص، از dropdown با نام Filter by Governance Groups استفاده کنید و governance groups موردنظر را انتخاب کنید.
دیدن جزئیات metricها
می‌توانید روی هر metric در dashboard کلیک کنید تا جزئیات بیشتری در dialog ببینید؛ مثل API specifications داخل metric، workspaceهایی که specificationها در آن قرار دارند، تعداد rules نقض‌شده و موارد مرتبط دیگر. همچنین می‌توانید روی نام specification، workspace name یا governance rule کلیک کنید تا در تب جدید باز شوند.
داده‌های گزارش به‌صورت منظم refresh می‌شوند، اما real time نیستند. برای زمان آخرین update، تاریخ بالای سمت راست dashboard را بررسی کنید.
metricهای اصلی گزارش
- Spec conformance status: تعداد specifications که governance rules روی آن‌ها اعمال شده است. بخش Conformant شامل specificationهایی است که violation ندارند یا فقط severityهای Info و Hint دارند. بخش Non conformant specificationهایی را نشان می‌دهد که severityهای Error یا Warning دارند.
- Rule violations by severity: تعداد violations بر اساس severity.
- Spec conformance over time: تعداد specificationهای دارای violation و بدون violation در هر ماه، طی ۱۲ months گذشته.
- Rule violations over time: تعداد rule violations بر اساس severity در هر ماه، طی ۱۲ months گذشته.
- Rules and violations: فهرست rules، تعداد violations هر rule و تعداد specificationهایی که هر rule را نقض کرده‌اند. با View more می‌توانید همه موارد را ببینید.
- Workspaces with most non-conformant Specs: workspaceهایی که بیشترین specification ناسازگار با governance rules را دارند.
نکته‌های عملی
- ابتدا Error و Warning را بررسی کنید، چون روی Non conformant شدن specification اثر دارند.
- Ruleهایی را که بیشترین violation دارند جدا کنید و پیام یا استاندارد آن‌ها را برای تیم شفاف‌تر کنید.
- از Governance Groups برای مقایسه وضعیت تیم‌ها یا دامنه‌های مختلف API استفاده کنید.
- با بررسی روند ۱۲ months گذشته، ببینید کیفیت specificationها بهتر شده یا بدتر.
منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.