סקירה כללית לפתרון בעיות בפורטל למפתחים שמבוסס על Drupal

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

בתור ספקי API, אתם זקוקים לדרך שבה תוכלו לחשוף את ממשקי ה-API, ללמד מפתחים על ממשקי ה-API, לרשום מפתחים ולאפשר למפתחים לרשום אפליקציות. ב-Apigee Edge יש פורטל שירותים למפתחים, שאפשר להשתמש בו כדי לבנות ולהשיק אתר מותאם אישית משלך כדי לספק את השירותים האלה לקהילת הפיתוח. למידע נוסף על פורטלים למפתחים, קראו את המאמר מהו פורטל למפתחים.

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

הסבר על SmartDocs

ניתן לייבא אל SmartDocs מפרט OpenAPI (JSON או YAML) או WADL המתאר את ה-API ולהשתמש בו כדי לפרסם בפורטל שלך תיעוד של הפניית API. מסמכי התיעוד של הפניית ה-API מופיעים באופן אוטומטי בכרטיסייה של ממשקי ה-API בפורטל שלך. המפתחים מגלים את תיעוד ה-API דרך הפורטל ויכולים לשלוח בקשות API בזמן אמת. בקשות ה-API מגיעות מדפדפן, לכן נדרשת תמיכה ב-CORS (שיתוף משאבים בין מקורות) כדי שהן יצליחו. התמיכה ב-CORS ניתנת על ידי שרת ה-proxy של "smartdocs" ב-Edge (בארגון "validATE") המשמש כשרת proxy לכל בקשות SmartDocs אל נקודת הקצה המיועדת. שרת ה-proxy של "מסמכים חכמים" נוצר כאשר מתקינים את SmartDocs.

לדוגמה:

כתובת ה-URL של שרת ה-Proxy של Smartdocs נחשפת כנכס שניתן להגדרה בקטע 'תצורה' -> 'SmartDocs' -> 'כתובת URL של שרת proxy של SmartDocs'. יכול להיות שיהיה צורך לשנות את כתובת ה-URL הזו אם ה-API נמצא ברשת פרטית ובקשות API פעילות דרך SmartDocs מהפורטל שלך נכשלו.


התקשורת בין פורטל המפתחים לבין Edge

פורטל המפתחים מאחסן ומאחזר את רוב המידע שהוא מציג מ-Edge, כולל Smartdocs, מפתחים, מוצרים ואפליקציות למפתחים. אפשר להגדיר את פרטי הארגון של Edge ואת פרטי הכניסה של devadmin באמצעות פקודת התפריט Configuration -> Devportal.

מידע נוסף זמין במאמר תקשורת בין הפורטל לבין Edge.