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

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

דרישות מוקדמות

נדרש חשבון בכתובת http://enterprise.apigee.com. אפשר להירשם לחשבון לתקופת ניסיון ב- http://accounts.apigee.com/accounts/sign_up.

כדי להשתמש בדוגמאות, צריך גם:

כלי	תיאור
Git	הדוגמאות נמצאות ב-GitHub. אם לא התקנת את Git, יש לעיין הוראות להגדרת Git ב-GitHub אם אתם לא רוצים להתקין את Git, תוכלו לעיין בקבצים ולהוריד קובץ ZIP בכתובת https://github.com/apigee/api-platform-samples.
Python	צריך להשתמש ב-Python כדי להריץ את כלי הפריסה של Apigee. שפת Python קיימת ברוב המקרים של Linux בסביבות Mac, במחשב Mac עם XCode, במחשב Windows שמותקן בו Cygwin ובמקומות רבים אחרים. כדי לקבל קוד Python, אפשר לעיין דף ההורדה של Python.
curl	גם סקריפטים לדוגמה של ההגדרה משתמשים ב-curl. חשוב לוודא שאפליקציית curl מותקנת ו זמינה בנתיב שלכם (מריצים את הפקודה which curl כדי לראות אם היא זמינה) במערכת שלך).
dos2unix	אם מפעילים את Cygwin ב-Windows, יכול להיות שנחוץ גם dos2unix של Google. (מנהל ההתקנה של Cygwin מאפשר להתקין את הכלי).

הורדת הדוגמאות

כדי לקבל את הקבצים לדוגמה, צריך להשתמש ב-git clone כדוגמה הבאה:

git clone https://github.com/apigee/api-platform-samples.git

ייבוא ופריסה של ה-API לדוגמה שרתי proxy

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

1. אחרי שמורידים את הדוגמאות עוברים לספרייה /setup, כפי שמוצג בדוגמה הבאה:

   cd setup

2. בספרייה /setup, מאתרים את הקובץ setenv.sh.
3. ערוך את הקובץ הזה כדי להגדיר את הארגון שלך, את כתובת האימייל המשויכת לשם המשתמש שלך, והסביבה (ייצור או בדיקה) שבה רוצים לפרוס את שרתי ה-proxy ל-API.
4. אחרי שעורכים את setenv.sh, צריך לבצע את הפעולות הבאות:

   sh deploy_all.sh

   הסקריפט הזה פורס את כל דוגמאות של שרתי proxy ל-API בארגון שלך. (התהליך אורך בין 3 ל-4 minutes.) לפעול לפי ההנחיות לפריסת מוצרי API, מפתחים ואפליקציות (המשמשים עבור OAuth).

5. בסיום הסקריפט לפריסה, עוברים אל ספריית ה-proxy לדוגמה. ב בספרייה sample-proxies, תופיע ספרייה אחת לכל שרת proxy לדוגמה. בכל פעם היא קובץ README.md שמכיל מידע על הרצת הדוגמה, ושני סקריפטים נעזור לכם לבצע שינויים קלים בדוגמאות, לפרוס ולאחר מכן להפעיל את המדגם כדי לראות איזו השפעה הייתה לשינוי:
   • invoke.sh: מריצים את הסקריפט הזה כדי להפעיל את הגרסה שנפרסה של ה-API שרת proxy.
   • deploy.sh: מריצים את הסקריפט הזה כדי לפרוס את ה-Proxy ל-API אחרי שמבצעים שינויים.

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

לכל שרת proxy לדוגמה משויך סקריפט מעטפת, שיכול לשמש להפעלת שרת ה-proxy ל-API לאחר הפריסה.

מהספרייה /sample-proxies/proxy_name, מריצים את הפקודה הבאים:

sh invoke.sh

הפעולה הזו מפעילה את שרת ה-proxy שפועל בסביבת הבדיקה בארגון.

פתרון בעיות

למידע על פתרון בעיות, קראו את המאמרים הבאים:

• מבוא לפתרון בעיות
• פתרון בעיות ב-Windows/Cygwin

שינוי של שרתי proxy לדוגמה ל-API ושימוש חוזר בהם

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

כדי לשנות דוגמה של שרת proxy ל-API כך שיצביע לשירות קצה עורפי אחר, צריך לשנות את קובץ תצורה של XML במיקום הבא:

/apiproxy/targets/target_name.xml

לדוגמה, כדי להפנות את דוגמת מפתח ה-API לשירות לקצה העורפי שלכם, מאתרים את הקובץ הבא:

/apikey/apiproxy/targets/default.xml

אם הגדרות ברירת המחדל מובילות אל http://mocktarget.apigee.net, למשל:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

ושירות לקצה העורפי זמין ב-http://api.myproject.com/, אז משנים את התצורה כך שתיראה כך:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

אחרי שתשמרו את השינויים, פרסו את ה-Proxy ל-API כפי שמוצג בדוגמה הבאה:

sh deploy.sh

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