בלוג

עיצוב JSON והעתקת JSON Pointer לערך מסוים

עצבו בדפדפן תגובת API בשורה אחת והעתיקו JSON Pointer מתצוגת העץ. הדוגמאות מציגות גם צמצום של JSON ובדיקת תחביר.

הממשק באנגלית מציג JSON בשורה אחת לצד הפלט המוזח.

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

שיפור הקריאות של תגובה בשורה אחת

הדביקו את הדוגמה הבאה בשדה ״קלט JSON״.

{"items":[{"sku":"A-001","stock":12},{"sku":"B-002","stock":0}]}
  1. הגדירו את ״הזחה״ לערך 2 ולחצו על ״עיצוב →״.
  2. בשדה ״פלט״, מצאו את הפריט השני במערך items. במוצר שהמק״ט שלו (sku) הוא B-002, הערך של stock הוא 0.
  3. כדי לשמור את התוצאה בקובץ, לחצו על ״העתקה״, הדביקו בעורך טקסט ושמרו. אם דרושה שורה אחת מצומצמת, לחצו על ״מיניפיקציה →״ לפני ההעתקה.
בממשק באנגלית הקלט מציג את רשימת המוצרים והפלט מציג JSON עם הזחה של שני רווחים.
השדות הנפרדים מאפשרים להשוות בין השורה המקורית למבנה לאחר העיצוב.

איתור הנתיב למלאי של המוצר השני בעץ

  1. השאירו את הקלט כפי שהוא ולחצו על ״תצוגת עץ״.
  2. הרחיבו את items ואת [1] ובחרו את "stock": 0. האינדקס במערך מתחיל באפס, ולכן [1] הוא הפריט השני.
  3. ודאו שה-JSON Pointer שנבחר הוא /items/1/stock ולחצו על ״העתקת נתיב״. רשמו את הנתיב וציינו איזו תגובה בדקתם.
בתצוגת העץ באנגלית הפריט השני תחת items פתוח ומופיע הנתיב /items/1/stock לערך שנבחר.
שדה הנתיב מציג את מיקום הערך שנבחר. הערך עצמו הוא 0.

ב-JSON Pointer כותבים לוכסן שבמפתח בתור ~1 וטילדה בתור ~0. לדוגמה, המפתח היחיד stock/on-hand נכתב stock~1on-hand. ראו תחביר RFC 6901.

בדיקת התחביר כשהעיצוב נכשל

אם תכתבו את הפריט השני כך: {"sku":"B-002","stock":0,}, הפסיק לפני הסוגר המסולסל הסוגר יגרום לשגיאת תחביר. לחצו על ״אימות״ לבדיקה. אם הדפדפן מספק את מיקום השגיאה, הכלי מציג את מספרי השורה והעמודה. מחקו את הפסיק ולחצו שוב על ״אימות״ לפני העיצוב.

״אימות״ בודק את תחביר ה-JSON. כדי לדעת אם stock הוא שדה חובה או אם מותר בו ערך שלילי, עיינו במפרט או בסכמה של ה-API.