Versioning API: '/v1/', 'קבל: גרסה', 'GraphQL aliasa &pos

ככל שה-API מתפתח, צצות שיטות חדשות, פרמטרים ולוגיקה. כדי לא לשבש את עבודתם של הלקוחות הנוכחיים, משתמשים ב-API. אנו תומכים במספר גישות לווסיונינג, המאפשרות לאינטגרטורים להשתמש בגרסה הרצויה של הממשק ללא סיכון לפעולה יציבה.

הדבר חשוב הן בעת הגדלת הפלטפורמה והן בעת יישום עדכונים, בדיקות או שירות לקוחות ותיקים.


שיטות וריאציה

שיטהתיאור ותועלת
גרסה בכתובת ('/v1/')הדרך הכי מובנת ופופולרית נוחה לשאר האף-פי-אי
קבל כותרתדוגמה: "קבל: יישום/vnd. אפי + ג 'סון; גרסה = 2 '- מפריד בין נתונים לגרסה
כינוי GraphQL/שדות מורחביםגרסאות שונות באמצעות שמות בדויים: ”Vaer1”, ”AutV2” - נוח לנדידה הדרגתית
גרסאות ברמת סכימהתרשימים ומודולים נפרדים ב ־ OpenAPI/Swagger עבור כל גרסה

כיצד מיושם

מבנה API עם '/v1/', '/v2/' ומסלולים עצמאיים

בדיקת כותרות ”קבל” ו-X-API-גרסה
  • GraphQL תומך בשמות בדויים ותרשימים (”averV1”, ”averV2”)
  • יכולת A/B לבחון גרסאות חדשות ללא סיכון לייצור
  • רישום שיחות לכל גרסה לניתוח ונדידה

יתרונות עסקיים ואינטגרטורים

תמיכה בלקוחות ישנים ללא האטה
  • מבצע מקביל רב-דורי של API
  • יישום בטוח של תכונות חדשות ללא שבירת תאימות לאחור
  • גמישות בקנה מידה ושדרוג תשתיות
  • נדידה ללא תפרים בין גרסאות מבוקרות ואנליטיות

איפה חשוב במיוחד

פלטפורמות עם לקוחות חיצוניים מרובים
  • פרויקטים עם גישה API-ראשון ואופן חיים ארוך
  • אינטגרציה עם בנקים, ספקים, שותפים B2B
  • מערכות עם סלולרי או לקוחות זמן רב

ורסינציה של API היא הבסיס לאמינות ולגמישות של אינטגרציות. ללא קשר לפורמט (REST, GRaphQL או gRPC), אנו מבטיחים פיתוח בטוח של ממשקים - ללא כשלים, קונפליקטים ואובדן תאימות.

צור קשר

מלאו את הטופס למטה ואנו נענה בהקדם.