רשימת דוגמאות

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

הדוגמאות של ממשק ה-API של Apigee Edge כוללות את ממשקי ה-proxy, המדיניות, הקוד והכלים של ה-API שמדגימים את היכולות של שירותי Apigee Edge API שמתוארים בהמשך.

לקבלת הוראות לשימוש בדוגמאות, קראו את המאמר שימוש בשרתי proxy לדוגמה של API.

למידה על ידי ביצוע

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

אחרי שמשכפלים את המאגר ומגדירים את הסביבה (התהליך נמשך כמה דקות בלבד), אפשר לנסות כל דגימה בתוך פחות מדקה. מאחר שכל דגימה יוצרת גרסה חדשה של אותו שרת proxy, הסביבה שלך לא תתמלא במבחר גדול של דוגמאות. אפשר להחליף גרסאות קודמות, לפרוס מחדש גרסה אחרת אחרת בממשק המשתמש לניהול ולבדוק את הקוד של שרת ה-proxy בכל שלב. דוח הקריאה של כל דגימה מספק גם סקירה קצרה של ביצועי הדגימה ואופן ההגדרה שלה.

כדאי לנסות! https://github.com/apigee/api-platform-samples/tree/master/learn-edge

דוגמאות של ספרי בישול

מסופקת קבוצת דוגמאות לנושאים בספר המתכונים של שרתי proxy ל-API.

שם	התיאור	סוגי מדיניות	מקורות מידע
ספר בישול ב-JavaScript	מדגים קטע JavaScript פשוט שמוסיף כותרות HTTP ממשתנים, משנה דוח מזג אוויר בפורמט XML מ-JSON ל-XML, וחותך תוכן למטה עבור לקוחות בנייד.	JavaScript XMLToJSON	segment.js setHeaders.js
javascript-mashup-cookbook	אפליקציית JavaScript מלאה שקוראת לממשקי API ציבוריים, משלבת תוצאות ויוצרת תשובה מועשרת לאפליקציית הלקוח. (הערה: שרת proxy זה של API מטמיע את אותה הפונקציונליות כמו של מיזוג המדיניות, ומדגים שניתן לטפל באותה בעיה באמצעות שיטות שונות).	JavaScript	MashItUp.js
Java-hello	הסבר Java פשוט של שלום עולם.	JavaCallout	JavaHello.java
java-cookbook	ממירה את התוכן והכותרות של התשובה לאותיות רישיות.	JavaCallout	ResponseUppercase.java
java-properties	הדגמה של אופן השימוש במאפיינים ביתרונות מרכזיים של Java.	JavaCallout	JavaProperties.java
שגיאת Java	הדגמה של דפוסי טיפול בשגיאות שבהם ניתן להשתמש בקוד היתרונות המרכזיים של Java.	JavaCallout	JavaError.java
מדיניות-mashup-cookbook	אפליקציה מלאה שמשתמשת בהרכב מדיניות כדי לקרוא לשני ממשקי API ציבוריים, משלבת תוצאות ויוצרת תגובה מועשרת לאפליקציית הלקוח. (הערה: שרת ה-proxy הזה של ה-API מטמיע את אותה הפונקציונליות של JavaScript-mashup, ומדגים שניתן לטפל באותה בעיה באמצעות שיטות שונות).	AssignMessage ServiceCallout ExtractVariables JavaScript XMLToJSON	GenerateResponse.js

שרתי proxy לדוגמה של API

שרתי ה-API הבאים נמצאים ב-GitHub, ודפי ה-readme מספקים תיאורים מפורטים של הדוגמאות. אם אתה רוצה לראות איך מדיניות מסוימת פועלת לפי דוגמה, צריך לחפש את המדיניות הרצויה בעמודה 'סוגי מדיניות' שבהמשך וללחוץ על השם לדוגמה בעמודה 'שם'. (כללי המדיניות מקושרים לדפי העזר הרלוונטיים במסמכים).

מקורות מידע וכלים

בנוסף לדוגמאות של ספרי המתכונים של Docs ולשרתי ה-proxy לדוגמה בטבלאות שלמעלה, הדוגמאות של Edge GitHub כוללות גם את המשאבים הבאים:

שם	התיאור	סוגי מדיניות	מקורות מידע
מהגנה מפני egex	המדיניות בנושא הגנה מפני איומים באמצעות ביטוי רגולרי יכולה להגן על ממשקי ה-API ועל המיקרו-שירותים לקצה העורפי מפני התקפות של החדרת SQL.	הגנה על ביטויים רגולריים	לא רלוונטי
oauth-validate-key-secret	אתה מטמיע את התהליך של סוג הענקת הסיסמה ל-OAuth. צריך לאמת גם את מפתח הלקוח וגם את הסוד של האפליקציה ב-Edge לפני התקשרות לספק זהויות חיצוני כדי לאמת את פרטי הכניסה של המשתמש.	OAuthV2, אחרים	לא רלוונטי
condition-pattern-matching	שרת ה-proxy הזה מאפשר לנסות ולבדוק בקלות הצהרות מותנות בתהליך של שרת proxy ב-API.	AssignMessage	לא רלוונטי
access-entity	מראה איך מאחזרים פרופילים של ישויות ממאגר הנתונים של Apigee Edge.	AssignMessage AccessEntity ExtractVariables	אין
apikey	הטמעת אימות של מפתח API פשוט	VerifyAPIKey AssignMessage מכסה	אין
תוסף יתרונות מרכזיים	הדגמה של הסבר אסינכרוני פשוט באמצעות לקוח ה-http של JavaScript.	JavaScript	assemble_response.js יתרונות מרכזיים.js
base64encoder	מדגים איך לקרוא לפקודות JavaScript ממשאבי JavaScript בשרתי proxy של API.	AssignMessage JavaScript	Core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js
מדיניות מותנית	יישמת אכיפה פשוטה של מדיניות מותנית. כשבקשה מכילה כותרת HTTP: Retime:true, המדיניות מפעילה סקריפט של Python שמוסיף קבוצה של מדדי ביצועים להודעת התגובה, ככותרות HTTP.	סקריפט (Python)	timer.py
נקודת קצה דינמית	הטמעה של ניתוב מותנה פשוט בתרחיש קצת יותר מורכב, שמגדיר שתי כתובות URL ונתיב ברירת מחדל אחד.	אין	אין
jira-release-notes	זהו שרת ה-proxy של ה-API, שצוות המסמכים של Apigee משתמש בו כדי ליצור נתוני גרסה מ-Jira.	JSONToXML XSL	releasenotes_api.xsl
kerberos-credential-Mediation	הדוגמה הזו מראה כיצד לבצע גישור של פרטי כניסה ל-Kerberos ב-Apigee Edge.	JavaCallout	קובץ Java JAR
oauth-advanced	דוגמה מלאה ופועלת לתהליך של סוג המענק של קוד ההרשאה, שבו Apigee Edge הוא שרת ההרשאות.	GenerateAccessToken GenerateAuthCode RefreshAccessToken ועוד הרבה אנשים...	להצגת הקוד לדוגמה
oauth-client-Credentials	מדגים נקודת קצה (endpoint) של אסימון OAuth 2.0 עם פונקציונליות מלאה שהוגדרה לסוג המענק של פרטי הכניסה של הלקוח.	GenerateAccessToken	אין
oauth-login-app	הוּצא משימוש. במקום זאת, אנחנו ממליצים לעיין בדוגמה oauth-advanced.
oauth-validate-key-secret	המחשה של שיטה לאימות המפתח והסוד של הלקוח לפני קריאה לספק זהויות כדי לאמת את פרטי הכניסה של המשתמש בתהליך של הענקת הסיסמה.	OAuthV2 AssignMessage ExtractVariables ServiceCallout RaiseFault	אין
oauth-verify-accesstoken	הדגמה של שרת proxy ל-API שמוגדר לאמת אסימוני גישה מסוג OAuth 2.0 ולאמת את המכסה.	VerifyAccessToken מכסה	אין
oauth10a-3legged	מדגים תצורה תלת-רגלית של OAuth 1.0a.	GenerateAceessToken GenerateRequestToken ServiceCallout VerifyAccessToken	אין
outbound-oauth	משתמש ב-Microsoft Azure Translation API כדי לתרגם ציוצים. לשם כך, האסימון מבצע קריאה יוצאת כדי לקבל אסימון גישה ל-OAuth, ולאחר מכן שומר את האסימון במטמון באמצעות מדיניות השמירה במטמון של שירותי ה-API, ומשתמש באסימון ששמור במטמון בכל פעם שמתבצעת קריאה יוצאת. כמו כן, היא כוללת אפליקציית דפדפן להדגמה שמשמשת להפעלת שרת ה-proxy של ה-API.	AssignMessage LookupCache PopulateCache JavaScript	api-config.js api-token-get.js translate-query.js translate-results.js
עימוד	מתבצע עימוד של הודעת תגובה בפורמט XML על סמך פרמטרים של הגבלה וקיזוז שסופקו על ידי הלקוח	AssignMessage ExtractVariables ResponseCache VerifyApiKey XSL	paginate.xslt
מטמון תשובות	מראה איך לשמור במטמון תחזיות מזג אוויר ב-Edge למשך 10 דקות.	ResponseCache AssignMessage	אין
simple-python	הדגמה של תרחיש פשוט של צירוף סקריפט python בתגובה שמוסיף לו ערך כותרת.	סקריפט (Python)	setHeader.py
סבון	מדגים טרנספורמציה של XSL שכותבת מחדש קובץ WSDL בתגובה לבקשה עם פרמטר השאילתה ?wsdl.	AssignMessage ExtractVariables סקריפט (Python) XSL	חישובaddress.py Fixwsdl.Pixel
סטרימינג	מדגים תצורה של סטרימינג ב-HTTP.	אין	אין
ניתוב-מחדש	הדגמה של שימוש ב-JavaScript לבחירה דינמית של כתובת URL יעד על סמך התוכן של הודעת בקשה.	ExtractVariables JavaScript	rewriteTargetUrl.js
twitter-mobile-timeline	מדגים איך להשתמש ב-JavaScript כדי להסיר פרמטרים מיותרים מהציוצים, וכך נוצר ציר זמן יעיל ב-Twitter שמתאים למכשירים ניידים בהגבלת משאבים.	AssignMessage JavaScript	MobileTimeline.js
twitter-oembed	הפונקציה הופכת תגובות בציר הזמן (למשל מ-Status/user_timeline.json) לתגובת oEmbed שמכילה את נתוני ציר הזמן כתוכן HTML עשיר.	AssignMessage JavaScript	search-oembed.js (חיפוש oembed.js)
משתנים	הדגמה של איך לחלץ ולהגדיר משתנים על סמך תוכן הודעות ב-Transport ו-JSON ו-XML.	AssignMessage ExtractVariables XMLToJSON	minimize.js
xmltojson	ממירה נתוני תגובה מ-XML ל-JSON.	XMLToJSON JSONToXML	אין
/schemas	קובצי סכימת XML שאפשר להיעזר בהם כשמגדירים שרתי proxy ל-API, כללי מדיניות, מוצרי API ופרופילים של מפתחים ואפליקציות.
/tools	מכיל כלי פריסה, deploy.py, שמייבא שרת proxy של API לארגון ב-Apigee Edge ולאחר מכן פורס אותו בסביבה שצוינה.
/org-snapshot	הכלי לצילום תמונת מצב של הארגון מאחזר הגדרות של הארגון, כולל מפתחים, מוצרי API, מארחים וירטואליים, מפות של מפתח/ערך וכו'. אפשר להשתמש בו כדי לגבות את הפרטים של ארגון או כדי לגלות את ההגדרות בארגון.

Apigee-127

למתכנתים, בעזרת Apigee-127 אפשר לתכנת שרתי proxy של API באמצעות Node.js ו-Sagger. אפשר למצוא דוגמאות של a127 גם ב-GitHub: https://github.com/apigee-127/a127-samples.

שיתוף החוויה שלך

כדאי לשתף את החוויות שלך בפורום למפתחים של Apigee.