אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע
אם אתם ספקי API, אתם צריכים דרך לחשוף את ממשקי ה-API שלכם, להסביר למפתחים על ממשקי ה-API שלכם, לרשום מפתחים ולאפשר להם לרשום אפליקציות. ב-Apigee Edge יש פורטל שירותים למפתחים שבו אפשר ליצור ולהשיק אתר מותאם אישית משלכם כדי לספק את השירותים האלה לקהילת הפיתוח שלכם. מידע נוסף על פורטלים למפתחים זמין במאמר מה זה פורטל למפתחים?
בקטעים הבאים מוסברים מושגי מפתח שחשוב להכיר לפני שמתחילים לפתור בעיות בפורטל למפתחים.
איך SmartDocs עובד
אפשר לייבא ל-SmartDocs מפרט OpenAPI (בפורמט JSON או YAML) או WADL שמתאר את ה-API שלכם, ולהשתמש בו כדי לפרסם בפורטל מסמכי עזר ל-API. מסמכי העזר של ה-API מופיעים באופן אוטומטי בכרטיסייה APIs בפורטל. מפתחים יכולים למצוא את מאמרי העזרה של ה-API בפורטל ולשלוח בקשות API בזמן אמת. מכיוון שהבקשות ל-API מגיעות מדפדפן, צריך תמיכה ב-CORS (שיתוף משאבים בין מקורות) כדי שהן יצליחו. התמיכה ב-CORS ניתנת על ידי ה-proxy smartdocs ב-Edge (בארגון VALIDATE), שפועל כ-proxy לכל בקשות SmartDocs לנקודת הקצה המיועדת. הפרוקסי smartdocs נוצר כשמתקינים את SmartDocs.
לדוגמה:
כתובת ה-URL של שרת ה-proxy של smartdocs מוצגת כמאפיין שאפשר להגדיר ב-Configuration -> SmartDocs -> SmartDocs proxy URL. יכול להיות שתצטרכו לשנות את כתובת ה-URL הזו אם ה-API שלכם נמצא ברשת פרטית ובקשות API פעילות באמצעות SmartDocs מהפורטל נכשלות.
איך הפורטל למפתחים מתקשר עם Edge
רוב המידע שמוצג בפורטל המפתחים מאוחסן ומאוחזר מ-Edge, כולל Smartdocs, מפתחים, מוצרים ואפליקציות למפתחים. אפשר להגדיר את פרטי הארגון של Edge ואת פרטי הכניסה של devadmin באמצעות פקודת התפריט Configuration -> Devportal.
מידע נוסף זמין במאמר בנושא תקשורת בין הפורטל ל-Edge.