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