קריאה לשיטה
POST או GET, גוף לעומת מחרוזת שאילתה, ומה בודק מאמת השדות.
שם השיטה הוא חלק מה-URL. כל קלט אחר, כולל מזהה, הוא פרמטר: שדה בגוף JSON ב-POST, ופרמטר
במחרוזת השאילתה ב-GET. שתי הצורות מגיעות לאותה שיטה ומחזירות את אותה מעטפת.
POST: גוף JSON
הצורה הרגילה לכל קריאה עם יותר משני פרמטרים, או עם אובייקט מקונן או מערך.
GET: מחרוזת שאילתה
נוח לבדיקה מהירה משורת הכתובת בדפדפן או משורה אחת של curl. השרת מנתח את מחרוזת השאילתה לאותו
גוף שמטפל השיטה רואה, ולכן הכללים שלהלן חשובים כאן יותר מאשר ב-POST.
הסוג המוצהר של שדה קובע איך ערך מחרוזת השאילתה נקרא:
- string: משמש כמות שהוא.
- number: עובר דרך
Number(...). - boolean: רק המחרוזת
trueנקראת כ-true. כל דבר אחר שמעבירים לשדה בוליאני ב-GET, כוללfalse, הופך ל-1שנחשב אמת. אם ערך בוליאני חשוב, שולחים אותו ב-POSTעםtrue/falseאמיתי של JSON, או פשוט משמיטים את הפרמטר כדי להשאיר אותו בברירת המחדל של השיטה. - object / array: הערך עובר דרך
JSON.parse(...), ולכן ערך מקונן ב-GETצריך להיות פרמטר שאילתה אחד שמחזיק מחרוזת JSON (filters=%7B%22status%22%3A%22open%22%7D), ולא קינון בסגנון סוגריים מרובעים.
שדות חובה ושגיאות סוג
לכל שדה של שיטה יש דגל mandatory ו-type. אם חסר שדה חובה, או נשלח סוג שגוי ב-POST (שבו שום
דבר לא מומר אוטומטית), מקבלים בחזרה -1 עוד לפני שהשיטה עצמה רצה:
מדריך ה-API האינטראקטיבי מציג את השדות של כל שיטה עם הסוגים ודגלי החובה שלהם, ומאפשר להריץ קריאה מהדפדפן ולראות את הבקשה המדויקת שנבנתה.