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

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

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

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

ללמוד בדרך של עשייה

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

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

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

דוגמאות לספרים של מתכונים ב-Docs

מוצגת קבוצה של דוגמאות לנושאים במדריך למשתמש של שרת ה-API.

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

דוגמאות לממשקי proxy ל-API

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

מסמכי עזר וכלים

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

שם	תיאור	סוגי מדיניות	משאבים
regex-protection	מדיניות ההגנה מפני איומים של ביטויים רגולריים יכולה להגן על ממשקי ה-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 Quota	אין
async-callout	הדגמה של קריאה פשוטת לאסינכרונית באמצעות httpClient של JavaScript.	JavaScript	assemble_response.js callout.js
base64encoder	הדגמה של קריאה לקובצי JavaScript מצורפים ממשאבי JavaScript בשרתי proxy של API.	AssignMessage JavaScript	core-min.js enc-utf16-min.js enc-base64-min.js encodeAuthHeader.js
conditional-policy	הטמעת אכיפה פשוטה של מדיניות מותנית. כשבקשה מכילה את הכותרת HTTP‏ responsetime:true, המדיניות מפעילה סקריפט Python שמוסיף קבוצה של מדדי ביצועים להודעת התגובה, ככותרות HTTP	סקריפט (Python)	timer.py
dynamic-endpoint	הטמעת ניתוב מותנה פשוט בתרחיש קצת יותר מורכב, שבו מוגדרות שתי כתובות URL ונתיב ברירת מחדל אחד.	אין	אין
jira-release-notes	זהו שרת ה-proxy של ה-API שבו צוות המסמכים של Apigee משתמש כדי ליצור הערות לגרסה מ-Jira.	JSONToXML XSL	releasenotes_api.xsl
kerberos-credential-mediation	בדוגמה הזו מוצג איך לבצע בחירת פרטי כניסה של Kerberos ב-Apigee Edge.	JavaCallout	קובץ JAR של Java
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 translator API כדי לתרגם ציוצים. לשם כך, הוא מבצע קריאה יוצאת כדי לקבל אסימון גישה ל-OAuth, ולאחר מכן מאחסן את האסימון במטמון באמצעות כללי מדיניות האחסון במטמון של API Services, ומשתמש שוב באסימון שנשמר במטמון בכל פעם שמתבצעת קריאה יוצאת. בנוסף, האוסף כולל אפליקציית דפדפן להדגמה שמשמשת להפעלת שרת ה-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
response-cache	הדגמה של שמירת תחזיות מזג האוויר במטמון ב-Edge למשך 10 דקות.	ResponseCache AssignMessage	אין
simple-python	הדגמה של תרחיש פשוט שבו מצרפים תסריט Python לתגובה ומוסיפים לה ערך של כותרת.	סקריפט (Python)	setHeader.py
soap	הדגמה של טרנספורמציה של XSL שמכתיבה מחדש קובץ WSDL בתגובה לבקשה עם פרמטר השאילתה ‎?wsdl.	AssignMessage ExtractVariables סקריפט (Python) XSL	calculateaddress.py fixwsdl.xsl
סטרימינג	הדגמה של הגדרת סטרימינג ב-HTTP.	אין	אין
target-reroute	הדגמה של שימוש ב-JavaScript כדי לבחור באופן דינמי כתובת URL יעד על סמך התוכן של הודעת הבקשה.	ExtractVariables JavaScript	rewriteTargetUrl.js
twitter-mobile-timeline	הדגמה של שימוש ב-JavaScript כדי להסיר פרמטרים מיותרים מטוויטים, וכתוצאה מכך לקבל ציר זמן יעיל ב-Twitter שמתאים למכשירים ניידים עם מגבלה על משאבים.	AssignMessage JavaScript	MobileTimeline.js
twitter-oembed	הקוד הופך תשובות של ציר זמן (למשל מ-statuses/user_timeline.json) לתגובה של oEmbed שמכילה את נתוני ציר הזמן כתוכן HTML עשיר.	AssignMessage JavaScript	search-oembed.js
variables	הדגמה של חילוץ והגדרה של משתנים על סמך תוכן ההודעות של התעבורה ו-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	הכלי ליצירת קובץ snapshot של הארגון מאחזר את הגדרות הארגון, כולל מפתחים, מוצרי API, מארחים וירטואליים, מפות מפתח/ערך וכו'. אפשר להשתמש בו כדי לגבות את הפרטים של הארגון או כדי לגלות את ההגדרות בארגון.

Apigee-127

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

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

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