אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info
מומלץ להשתמש בשיטות המומלצות שמתוארות בקטעים הבאים כשאתם יוצרים את הפורטל.
עידוד מעורבות מצד הקהל
מוסיפים תוכן שמעורר עניין ויזואלי בקרב הקהל וגורם לו לרצות לקבל מידע נוסף. מאפשרים לצרכני ה-API לעיין בחלק מהפורטל בלי להתחבר. כדאי לספק רישום בשירות עצמי כדי שהם יוכלו להתחיל לעבוד במהירות ולפתח אפליקציות באמצעות ממשקי ה-API שלכם.
מאפשרים למשתמשים לנסות את ממשקי ה-API שלכם
יצירת מסמכי עזרה אינטראקטיביים של ממשקי API באופן אוטומטי ממפרטי OpenAPI, כדי לאפשר למשתמשים:
- מידע על ה-API
- שליחת בקשה פעילה ל-API
הצגת תגובה בזמן אמת שחוזרת מה-API
מידע נוסף זמין במאמר פרסום ממשקי ה-API.
טיפול בתוכניות הלימודים הראשיות
כדאי לספק דוגמאות לתרחישים לדוגמה ומדריכים שרלוונטיים לקהל שלכם ובהתאם לרמת הניסיון שלו. כדאי להדגים באמצעות דוגמה, כמו רצף פשוט של פקודות curl, או להסביר שלב אחרי שלב נוהל מורכב יותר.
הטמעת אופטימיזציה למנועי חיפוש (SEO)
מוודאים שאפשר לחפש את התוכן. כדאי להשקיע ב-SEO שיעזור לכם לשפר את הדירוג בתוצאות החיפוש ולאפשר למשתמשים למצוא את התוכן שלכם.
כדאי להשתמש בשיטות המומלצות הבאות כשאתם יוצרים את המבנה של התוכן. מידע נוסף והנחיות נוספות מ-Google זמינים במדריך למתחילים בנושא אופטימיזציה למנועי חיפוש של Google.
| שיטה מומלצת | תיאור | יתרונות |
|---|---|---|
| יצירת כתובות URL ידידותיות למשתמש | יוצרים כתובות URL שקל להבין אותן ואפשר לקרוא אותן. מגדירים כתובת URL של דף ידידותית למשתמש כשמוסיפים דפים לפורטל, כפי שמתואר בקטע יצירת דף. |
|
| נותנים שם תיאורי לפורטל | מגדירים שם ייחודי ותיאור לפורטל, כפי שמתואר בקטע ניהול הפורטלים. התוכן הזה משמש לאכלוס התג <title> בדף הבית (index) של הפורטל. |
|
| קל להתמצא באתר | מגדירים מבנה ניווט הגיוני, כפי שמתואר בקטע הגדרת ניווט. |
|
| שימוש בשילוב טוב של ביטויים של מילות מפתח בתוכן | כדאי לכלול מילות מפתח בתוכן כשזה רלוונטי ומשתלם לעשות זאת. הבולטוּת של מחרוזת מילות מפתח בדף יכולה לשפר את דירוג הדף בתוצאות החיפוש. נסו לחזות את מחרוזות מילות המפתח שהמשתמשים עשויים להשתמש בהן כשהם מחפשים את התוכן שלכם. חשוב להיזהר מטחינת מילות מפתח, כלומר שימוש מוגזם במילות מפתח למטרה היחידה של שיפור דירוג החיפוש. כתוצאה מכך, מנועי החיפוש עשויים להעניש את האתר שלכם. | המשתמשים שמחפשים תוכן יקבלו יותר היטים רלוונטיים. |
יצירת קהילה של מפתחים
השתמשו ברשתות החברתיות כדי לקדם את קהילת ה-API שלכם דרך ערוצים רגילים ברשתות החברתיות, כמו Facebook, Twitter וכו'. פרסום בלוגים ופורומים שמעודדים תקשורת ואינטראקציה בין המפתחים בקהילה של ממשק ה-API.