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

מוטיבציה

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

• יצירה וביצוע של שאילתות ותסריטים (רצפים של שאילתות)
• כתיבת מבחנים מסוגים שונים
• יצירת מבחן
• עבודה עם תיאורי API, כולל ייבוא ​​מפורמטים כגון Swagger, OpenAPI, WADL וכו'.
• בקשות לועגות
• תמיכה טובה בשפה אחת או יותר לכתיבת סקריפטים, כולל אינטגרציה עם ספריות פופולריות
• וכו '

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

מי צריך כלי כזה? ברור שכל אלה שקשורים לפחות איכשהו לפיתוח ובדיקה של ממשקי API הם מפתחים ובודקים =). יתרה מכך, אם לראשונים די לעיתים קרובות לבצע שאילתות בודדות וסקריפטים פשוטים, הרי שלבודקים זהו אחד הכלים העיקריים, שבין היתר צריך לכלול מנגנון רב עוצמה לכתיבת מבחנים עם יכולת להריץ אותם. CI.

אז, בעקבות ההנחיות האלה, התחלנו ליצור את המוצר שלנו. בואו נראה מה השגנו בשלב זה.

התחלה מהירה

נתחיל בהיכרות ראשונה עם האפליקציה. אתה יכול להוריד את זה באתר שלנו. נכון לעכשיו, כל 3 הפלטפורמות העיקריות נתמכות - Windows, Linux, MacOS. הורד, התקן, הפעל. כאשר אתה מפעיל אותו בפעם הראשונה, ייתכן שתראה את החלון הבא:

לחץ על סימן הפלוס בחלק העליון של אזור התוכן כדי ליצור את הבקשה הראשונה שלך. לשונית השאילתה נראית כך:

בואו נסתכל על זה ביתר פירוט. ממשק הבקשות דומה מאוד לממשק של לקוחות מנוחה פופולריים, מה שמקל על ההגירה מכלים דומים. בוא נגיש את הבקשה הראשונה לכתובת האתר https://next.json-generator.com/api/json/get/NJv-NT-U8

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

1. גוף התגובה מיוצג בצורת עץ, אשר ראשית מוסיף תוכן מידע ושנית מאפשר לך להוסיף כמה תכונות מעניינות שעליהן להלן
2. קיימת לשונית הצהרות, המציגה רשימה של בדיקות עבור בקשה נתונה

כפי שאתה יכול לראות, הכלי שלנו יכול לשמש כלקוח מנוחה נוח. עם זאת, לא היינו כאן אם היכולות שלו היו מוגבלות רק לשליחת בקשות. לאחר מכן, אתאר את המושגים והפונקציונליות הבסיסיים של TestMace.

מושגים ותכונות בסיסיות

צומת

הפונקציונליות של TestMace מחולקת לסוגים שונים של צמתים. בדוגמה למעלה, הדגמנו את פעולת הצומת RequestStep. עם זאת, סוגי הצמתים הבאים זמינים כעת גם באפליקציה:

• RequestStep. זהו הצומת שדרכו תוכל ליצור בקשה. יכול להיות לו רק צומת Assertion אחד כרכיב צאצא.
• טַעֲנָה. הצומת משמש לכתיבת מבחנים. יכול להיות רק צומת צאצא של הצומת RequestStep.
• תיקיה. מאפשר לך לקבץ צומת תיקיה ו-RequestStep בתוך עצמם.
• פּרוֹיֶקט. זהו צומת השורש, שנוצר באופן אוטומטי כאשר הפרוייקט נוצר. אחרת, הוא חוזר על הפונקציונליות של צומת התיקיה.
• קישור. קישור לתיקיה או לצומת RequestStep. מאפשר לך לעשות שימוש חוזר בשאילתות ובסקריפטים.
• וכו '

הצמתים ממוקמים בשריטות (הפאנל בפינה השמאלית התחתונה, משמש ליצירת שאילתות "חד פעמיות" במהירות) ובפרוייקטים (הפאנל בפינה השמאלית העליונה), עליהם נתעכב ביתר פירוט.

פרויקט

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

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

משתנים

משתנים הם אחד ממנגנוני המפתח של יישום. לאלו מכם שעובדים עם כלים כמו TestMace אולי כבר יש מושג על מה אנחנו מדברים. אז משתנים הם דרך לאחסן נתונים נפוצים ולתקשר בין צמתים. אנלוגי, למשל, הם משתני סביבה ב- Postman או Insomnia. עם זאת, הלכנו רחוק יותר ופיתחנו את הנושא. ב-TestMace, ניתן להגדיר משתנים ברמת הצומת. כל. קיים גם מנגנון להורשת משתנים מאבות קדמונים ומשתנים חופפים בצאצאים. בנוסף ישנם מספר משתנים מובנים, שמות המשתנים המובנים מתחילים בהם $. הנה כמה מהם:

• $prevStep - קישור למשתנים של הצומת הקודם
• $nextStep - קישור למשתנים של הצומת הבא
• $parent - אותו דבר, אבל רק לאב הקדמון
• $response - תגובה מהשרת
• $env - משתני סביבה נוכחיים
• $dynamicVar - משתנים דינמיים שנוצרו במהלך ביצוע סקריפט או שאילתה

$env - אלה הם בעצם משתנים רגילים ברמת צומת הפרויקט, עם זאת, קבוצת משתני הסביבה משתנה בהתאם לסביבה שנבחרה.

הגישה למשתנה מתבצעת באמצעות ${variable_name}
הערך של משתנה יכול להיות משתנה אחר, או אפילו ביטוי שלם. לדוגמה, משתנה url יכול להיות ביטוי כמו
http://${host}:${port}/${endpoint}.

בנפרד, כדאי לשים לב לאפשרות של הקצאת משתנים במהלך ביצוע סקריפט. לדוגמה, לעתים קרובות יש צורך לשמור נתוני הרשאה (אסימון או הכותרת המלאה) שהגיעו מהשרת לאחר כניסה מוצלחת. TestMace מאפשר לשמור נתונים כאלה במשתנים דינמיים של אחד מהאבות הקדמונים. על מנת למנוע התנגשויות עם משתנים "סטטיים" שכבר קיימים, משתנים דינמיים ממוקמים באובייקט נפרד $dynamicVar.

תרחישים

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

השלמה אוטומטית והדגשת ביטוי

לעבודה נוחה עם משתנים (ולא רק) יש צורך בהשלמה אוטומטית. וכמובן, הדגשת ערכו של ביטוי כדי שיהיה קל ונוח יותר להבהיר למה שווה משתנה מסוים. זה בדיוק המקרה כשעדיף לראות פעם אחת מאשר לשמוע מאה פעם:

ראוי לציין שההשלמה האוטומטית מיושמת לא רק עבור משתנים, אלא גם, למשל, עבור כותרות, ערכים של כותרות מסוימות (לדוגמה, השלמה אוטומטית עבור כותרת Content-Type), פרוטוקולים ועוד ועוד. הרשימה מתעדכנת כל הזמן ככל שהאפליקציה גדלה.

בטל/בצע מחדש

ביטול/ביצוע מחדש של שינויים זה דבר מאוד נוח, אבל משום מה הוא לא מיושם בכל מקום (וכלים לעבודה עם ממשקי API אינם יוצאי דופן). אבל אנחנו לא מאלה!) הטמענו את ביטול/ביצוע מחדש לאורך כל הפרוייקט, מה שמאפשר לך לבטל לא רק עריכה של צומת ספציפי, אלא גם יצירה, מחיקה, הזזה וכו'. הפעולות הקריטיות ביותר דורשות אישור.

יצירת מבחנים

צומת ה-Assertion אחראי ליצירת בדיקות. אחת התכונות העיקריות היא היכולת ליצור מבחנים ללא תכנות, באמצעות עורכים מובנים.

צומת טענה מורכב מקבוצה של הצהרות. לכל קביעה יש סוג משלה; כרגע יש כמה סוגים של קביעות

1. השווה ערכים - פשוט משווה 2 ערכים. ישנם מספר אופרטורים להשוואה: שווה, לא שווה, גדול מ, גדול או שווה ל, קטן מ, קטן מ או שווה ל.

2. מכיל ערך - בודק את התרחשות מחרוזת משנה במחרוזת.

3. XPath - בודק שהבורר ב-XML מכיל ערך מסוים.

4. הצהרת JavaScript היא סקריפט ג'אווה סקריפט שרירותי שמחזיר אמת על הצלחה ושקר על כישלון.

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

הדובדבן שבקצפת הוא יצירה מהירה של קביעות מתגובות, רק תראו את זה!

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

תיאור API

TestMace מאפשר לך לא רק להשתמש ב-API, אלא גם לתעד אותו. יתרה מכך, לתיאור עצמו יש גם מבנה היררכי ומתאים באופן אורגני לשאר הפרויקט. בנוסף, כרגע ניתן לייבא תיאורי API מפורמטים של Swagger 2.0 / OpenAPI 3.0. התיאור עצמו לא סתם שוכב משקל מת, אלא משולב באופן הדוק עם שאר הפרויקט, בפרט, השלמה אוטומטית של כתובות URL, כותרות HTTP, פרמטרי שאילתה וכו' זמינה, ובעתיד אנו מתכננים להוסיף בדיקות להתאמה של התגובה לתיאור ה-API.

צומת שיתוף

מקרה: תרצה לשתף בקשה בעייתית או אפילו סקריפט שלם עם עמית או פשוט לצרף אותו לבאג. TestMace מכסה גם את המקרה הזה: האפליקציה מאפשרת לך לסידור כל צומת ואפילו תת-עץ בכתובת URL. העתק-הדבק ותוכל להעביר את הבקשה בקלות למכונה או לפרויקט אחר.

פורמט אחסון פרוייקטים הניתן לקריאה על ידי אדם

כרגע כל צומת מאוחסן בקובץ נפרד עם סיומת yml (כפי שקורה בצומת Assertion), או בתיקייה עם שם הצומת וקובץ index.yml.
לדוגמה, כך נראה קובץ הבקשות שעשינו בסקירה למעלה:

index.yml

children: []
variables: {}
type: RequestStep
assignVariables: []
requestData:
  request:
    method: GET
    url: 'https://next.json-generator.com/api/json/get/NJv-NT-U8'
  headers: []
  disabledInheritedHeaders: []
  params: []
  body:
    type: Json
    jsonBody: ''
    xmlBody: ''
    textBody: ''
    formData: []
    file: ''
    formURLEncoded: []
  strictSSL: Inherit
authData:
  type: inherit
name: Scratch 1

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

ההיררכיה של התיקיות במערכת הקבצים חוזרת לחלוטין על ההיררכיה של הצמתים בפרויקט. לדוגמה, סקריפט כמו:

ממפה את מערכת הקבצים למבנה הבא (רק היררכיית התיקיות מוצגת, אבל המהות ברורה)

זה מקל על תהליך סקירת הפרויקט.

יבוא מ- Postman

לאחר קריאת כל האמור לעיל, חלק מהמשתמשים ירצו לנסות (נכון?) מוצר חדש או (מה לעזאזל לא צוחק!) להשתמש בו לחלוטין בפרויקט שלהם. עם זאת, ההגירה יכולה להיעצר על ידי מספר רב של התפתחויות באותו דוור. במקרים כאלה, TestMace תומכת בייבוא ​​אוספים מ-Postman. נכון לעכשיו, יבוא ללא בדיקות נתמך, אך איננו פוסלים תמיכה בהם בעתיד.

תוכניות

אני מקווה שרבים מאלה שקראו עד לנקודה זו אהבו את המוצר שלנו. עם זאת, זה לא הכל! העבודה על המוצר בעיצומה והנה כמה תכונות שאנו מתכננים להוסיף בקרוב.

סנכרון בענן

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

CLI

כפי שהוזכר לעיל, מוצרים ברמת IDE לא יכולים להסתדר בלי כל מיני אינטגרציות עם יישומים או זרימות עבודה קיימות. ה-CLI הוא בדיוק מה שצריך כדי לשלב מבחנים שנכתבו ב-TestMace בתהליך האינטגרציה הרציף. העבודה על ה-CLI בעיצומה; גרסאות מוקדמות ישיקו את הפרויקט עם דוח מסוף פשוט. בעתיד אנו מתכננים להוסיף פלט דוח בפורמט JUnit.

מערכת פלאגין

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

הרחבת מגוון סוגי הצמתים

סט צמתים זה אינו מכסה את כל המקרים הנדרשים על ידי המשתמש. צמתים שמתוכננים להתווסף:

• צומת Script - ממיר וממקם נתונים באמצעות js וה-API המתאים. באמצעות סוג זה של צומת, אתה יכול לעשות דברים כמו סקריפטים של בקשה מראש ואחרי בקשה ב-Postman.
• צומת GraphQL - תמיכה ב-graphql
• צומת קביעה מותאמת אישית - יאפשר לך להרחיב את מערך הקביעות הקיימות בפרויקט
  מטבע הדברים, זו אינה רשימה סופית, היא תתעדכן כל הזמן עקב, בין היתר, המשוב שלך.

שאלות נפוצות

במה אתה שונה מפוסטמן?

1. הרעיון של צמתים, המאפשר לך להרחיב כמעט ללא סוף את הפונקציונליות של הפרויקט
2. פורמט פרויקט קריא לאדם עם שמירתו במערכת קבצים, מה שמפשט את העבודה באמצעות מערכות בקרת גרסאות
3. יכולת ליצור בדיקות ללא תכנות ותמיכה ב-js מתקדמת יותר בעורך הבדיקות (השלמה אוטומטית, מנתח סטטי)
4. השלמה אוטומטית מתקדמת והדגשה של הערך הנוכחי של משתנים

האם זה מוצר בקוד פתוח?

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

ממה אתה חי?)

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

מסקנה

הפרויקט שלנו מתקדם בצעדי ענק לקראת שחרור יציב. עם זאת, ניתן כבר להשתמש במוצר, והמשוב החיובי מהמשתמשים המוקדמים שלנו הוא הוכחה לכך. אנו אוספים משוב באופן אקטיבי, כי ללא שיתוף פעולה הדוק עם הקהילה אי אפשר לבנות כלי טוב. אתה יכול למצוא אותנו כאן:

אתר רשמי

מברק

רפוי

פייסבוק

מעקב אחר בעיות

אנו מצפים לרצונות ולהצעות שלך!

מקור: www.habr.com