פוסטמן מול Swagger

בלי כתוביותעם כתוביות

מילון מושגים:

Postman - כלי לבדיקת API: שליחת בקשות HTTP לשרת ובחינת התגובות, נפוץ בפיתוח ובבדיקות.

API - ממשק תכנותי שמגדיר כיצד תוכנה אחת פונה לאחרת ומחליפה איתה נתונים ופעולות.

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

HTTPS - הגרסה המאובטחת של HTTP, שמצפינה את התקשורת בין הדפדפן לשרת בעזרת TLS ומאמתת את זהות האתר.

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

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

URL - הכתובת שמזהה משאב באינטרנט, למשל דף אתר, וכוללת פרוטוקול, שם מארח ונתיב.

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

פוסטמן מול Swagger

הפתרון לתרגיל: בקשת Forecast ל-weatherapi.com, תחזית של שלושה ימים בירושלים. בנוסף, ההרצאה מראה כלי דומה ל-Postman שמוגש באתר עצמו.

פתרון התרגיל

1. בדיקה ב-API Explorer: בוחרים את ה-Endpoint של forecast, מזינים את ה-key מתוך My Account, בוחרים HTTPS ו-JSON, מיקום ירושלים ו-days שלוש. אחרי show response הקוד הוא 200 ובגוף התשובה יש תחזית לשלושת הימים הקרובים.

2. בקשה חדשה ב-Postman: ב-Add Request נותנים שם Forecast ומדביקים את ה-URL מהדוגמה. אחרי Save ו-Send מתקבלות אותן תוצאות.

3. שינוי ערכים: קל לשנות את מספר הימים משלושה לאחד, ללחוץ Save ו-Send ולקבל תוצאה חדשה.

4. משתנים: ה-Endpoint לא צריך שינוי, כי הוא forecast.json. את ה-key צובעים ושומרים כמשתנה בשם token ב-Scope של Collection.

5. עדכון הטוקן: אם הטוקן משתנה, מעדכנים רק את ה-current value בלשונית Variables של ה-Collection.

Swagger

באתר, במסך My Account, יש כלי Swagger ששולח את הבקשות ישירות. מזינים את ה-key ב-Authorize, ממלאים q ו-days, למשל תל אביב ושלושה ימים, ולוחצים Execute. הכלי מזכיר את Postman. שימושי לבדיקה וחקירה של האתר, ואילו Postman מספק עוד יכולות.

אחרי ההרצאה אפשר לבנות בקשת Forecast, לשים את ה-key כמשתנה, ולהכיר את Swagger.

השיעור הבא בקורס: שם משתנה בפוסטמן

פרקי ההרצאה: פוסטמן מול Swagger

תמלול ההרצאה: פוסטמן מול Swagger

הטקסט המלא של הדקות הראשונות בהרצאה «פוסטמן מול Swagger» בקורס הווידאו של PracticU – כתוביות בעברית עם זמן התחלה לכל פסקה. כך תוכלו לקרוא ולחפש את הנושאים לפני שמתחילים ללמוד.

00:02
אז המשימה שרציתי שנבצע זה שנייצר ריקווייסט נוסף בפוסטמן באתר weather API ונבדוק אין פוינט מסוג פורקאסט ואז נעשה שאילתא או ריקווייסט של הפורקאסט לשלושה ימים מזג האוויר בירושלים.
00:21
כלומר תחזיק נזק האוויר לפי האתר weather API לשלושה ימים הקרובים בירושלים. אז איך אני ניגש למשימה הזאתי? ניגשנו לאתר של Weather API ורצינו לראות את ה-API Explorer.
00:34
יש לנו פה את ה-Endpoint של קארנט, אבל אנחנו רוצים לבדוק את פורקסט Endpoint, זאת אומרת, ה-Endpoint של פורקסט, של תחזית. אני לוחץ ואז אני רואה את הפרמטרים ואני יכול לשים את ה-Key שלי. ה-Key שלי זה מה שהוצאתי פה מ-My Account אחרי הרישום, הרישום הקצר והחינמי. אז אני לוקח את ה-Key, שזה הטוקן למעשה שמאפשר לי.
00:58
אני מדביק אותו פה your api key אני רוצה פרוטוקול htts json לונדון אני רוצה ג'רוסלם ו-forecast אני מסמן ימים שלושה שאר הפרמטרים אני לא רוצה ואני לוחץ על show response אז אנחנו רואים שה-response קוד 200 וזה ה-request את העדר אני כרגע אניח כן אני לא צריך אותו אבל ה-response body אני רואה שיש את ה-forecast
01:25
של הימים הקרובים אוקיי אז יש לנו חתיכת מידע של שלושה ימים קרובים ואני יכול עכשיו להגיע לשלב היישום ולראות איך אני עושה את זה בפוסטמן אז אני פותח את הפוסטמן יש לי את הקארנט וודר ואני רוצה ליצור ריקווסט חדש ריקווסט אחד של קארנט אבל הפעם אנחנו רוצים ריקווסט של
01:48
פורקאסט אד ריקווסט אני קורא לזה פה פורקאסט ואני אדביק את ה-base url כמו או שלקחתי את זה מהקטע של הדוגמה של API Explorer.