כיצד לבקש את ממשק ה-API הראשון שלך ב״קיצורים״ ב-Mac
על-מנת לבקש את ה-API הראשון שלך, יש ליצור כתובת אינטרנט המצביעה על ״נקודת הקצה״ של ה-של API שברצונך לדבר עמו, ולאחר מכן להעביר כתובת זו לפעולה ״קבל תוכן של כתובת אינטרנט״. בעת פעולת הקיצור, פעולה זו תבצע את בקשת ה-API.
בניית בקשת ה-API
נקודת הקצה של Typicode מחייבת את המבנה הבא עבור בקשת כתובת אינטרנט:
https://jsonplaceholder.typicode.com/[RESOURCE]
המלל בסוגריים הוא המשאב שברצונך לגשת אליו. Typicode מספק דוגמאות רבות ושונות לבדיקת בקשות. בדוגמה הזו נעשה שימוש ב-https://jsonplaceholder.typicode.com/users כדי לבקש רשימת משתמשים.
ביישום ״קיצורים״
ב-Mac, יש להוסיף את הבקשה לכתובת ה-URL.הבקשה
usersתחזיר רשימת משתמשים.ניתן למקד את החיפוש על-ידי ציון משתמש ספציפי לפי המזהה:
https://jsonplaceholder.typicode.com/users/6. חיפוש זה יחזיר את המשתמש שהמזהה שלו הוא 6.מרבית ממשקי ה-API מאפשרים שימוש בשאילתות בעלות המבנה הבא:
https://jsonplaceholder.typicode.com/users?username=Bret. הסימן ״?״ מפעיל את השאילתה שמחפשת פריטים לפי זוגות מפתח/ערך. בדוגמה הזו, השאילתה?username=Bretמחפשת משתמש ששם המשתמש שלו הוא Bret.בדוק/י בתיעוד של ה-API אילו שאילתות וחיפושים נתמכים.
ביצוע בקשת ה-API באמצעות הפעולה ״קבל תוכן של כתובת אינטרנט״
ביישום ״קיצורים״
ב-Mac, אפשר ללחוץ על ״הצג עוד״ בפעולה ״קבל תוכן של כתובת אינטרנט״.האפשרויות הבאות עבור סוגי בקשות ה-API שביכולתך לבצע הופכות לזמינות:
הפעולה
GETמאפשרת לאחזר נתונים.
POSTמאפשרת לך ליצור נתונים חדשים.הפעולה
PUTמאפשרת לעדכן נתונים על ידי החלפתם.הפעולה
PATCHמאפשרת לעדכן נתונים על ידי שינוי שלהם.
DELETEמאפשרת לך להסיר אובייקט שצוין בבקשת ה-URL.
עבור דוגמה זו, השתמש/י בבקשת
GETלאחזור נתונים מה-API של Typicode.כעת כשפעולת כתובת האינטרנט קיבלה את בקשתך והפעולה ״קבל תוכן של כתובת אינטרנט״ מוגדרת לנתוני
GET, ניתן לבצע את בקשת API.הערה: כשהפעולה ״קבל תוכן של כתובת אינטרנט״ עוברת ל-
POST,PUTאוPATCH, מתווסף פרמטר חדש בשם ״גוף בקשה״. ״גוף בקשה״ מאפשר לך לשלוח JSON, טופס או קובץ ל-API כחלק מבקשתך. פעולה זו מאפשרת לך להכניס נתונים חדשים באופן ידני או על-ידי שימוש במשתנים כך שניתן לשלוח את הנתונים ל-API ליצירה, להחלפה או לשינוי של רשומה.לבדיקת הקיצור, לחץ/י על
.
במבט ראשון, נראה כי ה-API מחזיר מלל מבולגן. נתונים אלה מקודדים ב-JSON, ראשי תיבות של JavaScript Object Notation.
על-מנת לקבל מידע נוסף בנושא העבודה עם JSON ולהמשיך עם דוגמת ה-API של Typicode, ראה/י מבוא לשימוש ב-JSON ב״קיצורים״ ב-Mac.