כאשר עובדים עם API בין צוותים או שותפים חיצוניים, חשוב במיוחד שהפורמט של בקשות ותגובות יישאר צפוי. בדיקת החוזה מאפשרת לך לוודא ששני הצדדים - הלקוח והשרת - מסכימים למבנה ההחלפה ואינם מפרים אותו במהלך העדכונים.
אנו מיישמים בדיקות חוזה שבודקות באופן אוטומטי ציות API עם תיעוד או ציפיות צרכנים - לפני שנכנס לייצור.
מהו חוזה API
חוזה הוא הסכם המגדיר:- אילו שדות מכילים את הבקשה והתגובה
- מה פורמטים נתונים מותרים
- איזה קודי מצב מוחזרים
- אילו פרמטרים נדרשים
הפרת חוזה לקוח פוטנציאלי או כשל שירות.
איך זה עובד?
| מסיבה | מה נבדק? |
|---|---|
| ספק (API) | API חייב לענות על ציפיות הלקוח עבור מבנה תגובה |
| לקוח (צרכן) | הלקוח ממתין לתכנית מסוימת - הבדיקה בודקת שהוא נפגש |
| דו כיווני | בדיקה דו כיוונית: גם הלקוח וגם השרת מסכימים להתכווץ |
כלים בשימוש: Pact, Spring Cloud Contract, Dred, Postman Contract Tests.
יתרונות של בדיקת חוזה
זיהוי אי ־ התאמות לפני התרוקנות
הגן מפני שינויים ”שקטים” ששוברים לקוחות
עדכון בטוח של גרסאות API
הגדלת האמון בין צוותי הפיתוח
חוזה הרישום משנה את ההיסטוריה
איך אנחנו מיישמים
הגדר חוזי OpenAPI/Pact
שילוב CI עם בדיקה אוטומטית פועל בכל התחייבות
הדמיה והיסטוריה של שינויי חוזה
היערכות/הפקה
פרסום חוזים לאינטגרטורים חיצוניים
איפה חשוב במיוחד
מיקרו-רחם של אחריות משותפת
פלטפורמות עם אינטגרציית B2B חיצונית
עובד על API עם פקודות עצמאיות מרובות
מערכות קריטיות שבהן טעות אינה מקובלת (פיננסים, שירותים ציבוריים)
בדיקת חוזה היא גשר אמין בין השרת ללקוח. אנחנו נעזור לכם לבנות תהליך שבו שום עדכון לא יפריע לאינטגרציה ולא יביא חרקים בלתי צפויים.