מחקה API

מחקה API הוא סביבת פיתוח משולבת בדפדפן לחקירת ממשק GraphQL API של הפרויקט שלך. הוא מאפשר למפתחי Archie Core לבנות ולהריץ שאילתות GraphQL בקלות מתוך סביבת העבודה.

מחקה API משתמש בנתונים החיים האמיתיים שלך.

---

אינטרוספקציה

סכמת GraphQL כוללת מערכת אינטרוספקציה מובנית שמפרסמת את מבנה הסכמה. זה מאפשר למחקה API לספק תכונות השלמה אוטומטית חזקות בעת כתיבת שאילתות GraphQL.

ברגע שנכנסים לבלוק items, הקלד “em”. מכאן קל לראות ולבחור את שדה email מהפעולות הזמינות ב-API. ההשלמה האוטומטית היא קונטקסטואלית לפי מיקומך בשאילתה הנבנית, ומסננת אפשרויות לפי מה שמוקלד.

כדי להפעיל את רשימת ההשלמה האוטומטית ידנית ולהציג את האפשרויות הזמינות, לחץ על צירוף המקשים [Shift] + [SPACE]. פעולה זו מציגה את רשימת ההקשר, ומאפשרת לך לבחור את השדה הנדרש, כמו items, מהרשימה.

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

גישה לתיעוד API

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

1. לוח התיעוד

לחץ על כפתור Documentation בסרגל הכלים העליון הימני.

2. ניווט מהיר קונטקסטואלי

ניתן לעבור ישירות לתיעוד עבור שדה ספציפי שאתה כותב.

הבונה

הבונה הוא כלי בניית שאילתות ויזואלי שפתוח בדרך כלל כברירת מחדל בצד השמאלי של מחקה API.

query MyQuery {
  cities {
    items {
      nameCity
    }
  }
}