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

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

אתה יכול להשתמש בכלים של צד שלישי כמו Postman כדי לבצע את קריאות ה-API שלך. אבל תוסף VS Code מאפשר לך לבצע קריאות API ישירות מתוך VS Code. כאן תלמד כיצד לבצע בקשות API בקוד VS.

הרחבת לקוח VS Code REST

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

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

כדי להתקין את לקוח REST, פתח את קוד VS ולחץ על הרחבות לשונית. לחפש אחר לקוח REST ולחץ על להתקין לחצן כדי להוסיף אותו לקוד VS.

instagram viewer

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

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

ביצוע בקשת GET באמצעות תוסף הלקוח REST

התחל ביצירת א .http קובץ עבור בקשות ה-API שלך. אתה יכול לתת שם לקובץ myrequests.http.

הוסף את הקוד הבא שלך myrequests.http קובץ כדי לאחזר משאב מה-API של JSONPlaceholder עם 1 כמזהה שלו:

לקבל https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

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

כך אתה מבצע בקשת GET בתוך קוד VS.

ביצוע בקשת POST באמצעות תוסף הלקוח REST

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

כדי ליצור משאב חדש ב-JSONPlaceholder API, החלף את הקוד ב- myrequests.http קובץ עם הדברים הבאים:

הודעה https://jsonplaceholder.typicode.com/posts HTTP/1.1
Content-Type: "application/json"
{
 "title": "פו",
 "body": "בר",
 "UserId": 1
}

לחץ על שלח בקשה לחצן כדי לשלוח את הבקשה. שוב, זה יפתח חלון חדש המכיל את נתוני התגובה. התגובה מראה א HTTP/1.1 201 נוצר הודעה ומזהה הפוסט יחד עם נתונים אחרים אם קריאת ה-API הצליחה.

{
 "id": "101"
}

ביצוע בקשת PUT באמצעות תוסף הלקוח REST

אתה מבצע בקשת PUT כאשר אתה רוצה לעדכן נתונים בשרת.

כדי לעדכן משאב קיים ב-API של JSONPlaceholder, החלף את הקוד שלך myrequests.http קובץ עם הדברים הבאים:

לָשִׂים https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Content-Type: "application/json"
{
 "title": "foo חדש",
 "body": "סרגל חדש",
 "UserId": 1
}

לאחר שליחת הבקשה, המשאב יתעדכן בשרת המדומה ותקבל HTTP/1.1 200 בסדר הוֹדָעָה.

ביצוע בקשת PATCH באמצעות תוסף הלקוח REST

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

כדי לעדכן רק את הכותרת של משאב קיים בשרת המדומה, החלף את הקוד שלך myrequests.http קובץ עם הדברים הבאים:

https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1 
Content-Type: "application/json"
{
 "title": "עוד פו"
}

לאחר שתגיש את הבקשה, כותרת המשאב תתעדכן בשרת המדומה ותקבל HTTP/1.1 200 בסדר הודעה יחד עם שאר הנתונים של המשאב.

ביצוע בקשת DELETE באמצעות תוסף הלקוח REST

אתה מבצע בקשת DELETE כאשר אתה רוצה למחוק משאב בשרת.

כדי למחוק משאב קיים בשרת המדומה, החלף את הקוד שלך myrequests.http קובץ עם הדברים הבאים:

לִמְחוֹק https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1

הנה ה סוג תוכן אינו נדרש, וגם לא אובייקט הנתונים. אם תשלח את הבקשה ותמחק בהצלחה את המשאב, אתה אמור לקבל HTTP/1.1 200 בסדר תגובה עם חפץ ריק.

בצע קריאות API ישירות מתוך קוד VS

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

למרות שיש כמה כלי בדיקת API מקוונים, אבל עם הרחבות כמו REST Client, בדיקת ממשקי API היא הרבה יותר מהירה וקלה יותר. אתה יכול לבדוק כל API ישירות מתוך עורך VS Code שלך. זה שימושי במיוחד אם אתה מפתח ממשקי API באופן מקומי ורוצה לבדוק את ממשקי API המקומיים שלך תוך כדי תנועה.

בדיקות API אחרות VS הרחבות קוד

Rest Client קל לשימוש. אבל, זה לא הרחבת VS Code היחידה לבדיקת ממשקי API. אפשרויות פופולריות נוספות הן Thunder Client, httpYak ו-httpBook.

Thunder Client מספק עורך API חזותי כדי לפשט בקשות API. כמובן, אתה צריך לדעת מה זה REST API כדי להשתמש בכלים האלה.