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