המטרה
- בדיקת תקינות קבלת הנתונים ממשק חיצוני
- יצירת מקטע API למטרות שונות
API
- מקטע בכתובת ה - URL המאפשר קבלת ושליחת מידע בין שני ממשקים שונים
- מפתח API - מקטע טקסט המעניק אישור להעברת מידע ויוצר חיבור בין מאגר הנתונים של smoove למאגרי נתונים חיצוניים
איך עושים את זה?
- כניסה לswagger -
-
- נגיע לתפריט הגדרות
- נבחר ב"מפתחות API"
- נלחץ על "קישור לשידור" מצד שמאל בשורת המפתח הרלוונטי
2. בתוך הswagger -
-
-
- TOKEN - מפתח הAPI
- נבחר את הפעולה הרצויה מתוך סרגל הפעולות משמאל
- Parameters - נלחץ על body sample בסרגל הימני
- נשלים את פרטי הParameters בהתאם לפעולה הרצויה לבדיקה
-
*יש לשים לב - פעולה שתתבצע בswagger - תתבצע גם בתוך smoove!
-
-
- נשלים שדות נוספים במידה וקיימים
-
נבצע בדיקה
- יש לוודא כי פורמט קבלת התשובה הינו - application/json
- נלחץ על try
-
-
-
חלון תוצאות הבדיקה -
- RESPONSE CODE - מציג האם הבדיקה הצליחה או נכשלה
- משמעות הקוד נמצא תחת Response Messages
-
במידה וישנה שגיאה בקוד
- נבדוק את משמעות השגיאה לפי Response Messages
- נכתוב את השינויים הנדרשים בקטע הקוד ונבצע בדיקה חוזרת
- נזין את המקטע התקין למקום הרצוי בקוד
-
חלון תוצאות הבדיקה -
דוגמא לבדיקת תקינות תקשורת - יצירת / עדכון איש קשר