אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info
בתור ספקי 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' נוצר כאשר מתקינים את SmartDocs.
לדוגמה:
כתובת ה-URL של שרת ה-proxy של SmartDocs מוצגת כמאפיין שניתן להגדרה בקטע Configuration (הגדרה) -> SmartDocs -> SmartDocs proxy URL (כתובת ה-URL של שרת ה-proxy של SmartDocs). יכול להיות שתצטרכו לשנות את כתובת ה-URL הזו אם ה-API שלכם נמצא ברשת פרטית ובקשות API פעילות באמצעות SmartDocs מהפורטל נכשלות.
איך פורטל המפתחים מתקשר עם Edge
רוב המידע שמוצג בפורטל למפתחים נשמר ב-Edge ומאוחזר ממנו, כולל מסמכי Smartdocs, מפתחים, מוצרים ואפליקציות למפתחים. אפשר להגדיר את פרטי הארגון ב-Edge ואת פרטי הכניסה של מנהל הפיתוח באמצעות הפקודה בתפריט Configuration (הגדרה) -> Devportal (פורטל הפיתוח).
למידע נוסף, ראו תקשורת בין הפורטל ל-Edge.