כיצד לבדוק GraphQL באמצעות דוור
1. סקירה כללית
במדריך קצר זה, נראה כיצד לבדוק נקודות קצה של GraphQL באמצעות Postman.
2. סקירה כללית ושיטות
נשתמש בנקודות הקצה שנוצרו במדריך GraphQL שלנו. כזכור, הסכימה מכילה הגדרות המתארות פוסטים ומחברים:
הקלד Post {id: ID! כותרת: מחרוזת! טקסט: מחרוזת! קטגוריה: מחבר מחרוזת: מחבר! } הקלד מחבר {id: ID! שם: מחרוזת! תמונה ממוזערת: הודעות מחרוזת: [פוסט]! }בנוסף, יש לנו שיטות להצגת פוסטים וכתיבת הודעות חדשות:
הקלד שאילתה {recentPosts (ספירה: Int, קיזוז: Int): [פוסט]! } הקלד Mutation {writePost (title: String !, text: String !, category: String): Post! }בעת שימוש במוטציה לשמירת נתונים, ה- שדות חובה מסומנים בסימן קריאה. שימו לב גם שבשלנו מוּטָצִיָה, הסוג שהוחזר הוא הודעה, אבל ב שאילתא, נקבל רשימה של הודעה חפצים.
ניתן לטעון את הסכימה הנ"ל במקטע ה- API של הדוור - פשוט הוסף ממשק API חדש עם GraphQL הקלד ולחץ צור אוסף:
ברגע שאנחנו טוענים את הסכימה שלנו, אנחנו יכולים כתוב בקלות שאילתות לדוגמה באמצעות תמיכת ההשלמה האוטומטית של פוסטמן ב- GraphQL.
3. בקשות GraphQL בדוור
קודם כל, הדוור מאפשר לנו לשלוח את גוף בפורמט GraphQL אנו פשוט בוחרים באפשרות GraphQL להלן:
לאחר מכן נוכל לכתוב שאילתת GraphQL מקורית, כמו זו שמביאה לנו את כותרת, קטגוריה, ומחבר שֵׁם לחלק QUERY:
שאילתה {recentPosts (ספירה: 1, קיזוז: 0) {מחבר קטגוריית כותרת {name}}}וכתוצאה מכך נקבל:
{"data": {"recentPosts": [{"title": "Post", "category": "test", "author": {"name": "Author 0"}}}}אפשר גם שלח בקשה בפורמט הגולמי, אבל עלינו להוסיף סוג תוכן: יישום / graphql למדור הכותרות. ובמקרה זה, הגוף נראה אותו דבר.
לדוגמא, אנו יכולים לעדכן כותרת, טקסט, קטגוריה, קבל תְעוּדַת זֶהוּת ו כותרת כתגובה:
מוטציה {writePost (כותרת: "פוסט", טקסט: "test", קטגוריה: "test",) {id title}}סוג הפעולה - כמו שאילתא ו מוּטָצִיָה - ניתן להשמיט מגוף השאילתה כל עוד אנו משתמשים בתחביר קצר. במקרה זה איננו יכולים להשתמש בשם הפעולה ובמשתנים, אך מומלץ להשתמש בשם הפעולה בכדי לבצע רישום וניתוח באגים קלים יותר.
4. שימוש במשתנים
במקטע המשתנים נוכל ליצור סכמה בפורמט JSON שתקצה ערכים למשתנים. זה נמנע מהקלדת ארגומנטים במחרוזת שאילתה:
אז נוכל לשנות את הודעות האחרונות גוף בקטע QUERY כדי להקצות דינמית ערכים ממשתנים:
שאילתה recentPosts ($ count: Int, $ offset: Int) {recentPosts (count: $ count, offset: $ offset) {קטגוריית טקסט כותרת מזהה}}ונוכל לערוך את החלק GRAPHQL VARIABLES עם מה שהיינו רוצים שהמשתנים שלנו יוגדרו:
{"count": 1, "offset": 0}5. סיכום
אנו יכולים לבדוק את GraphQL בקלות באמצעות Postman, מה שמאפשר לנו גם לייבא את הסכימה וליצור שאילתות עבורה.
אוסף של בקשות ניתן למצוא באתר GitHub.
