שימוש בשרתי 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

כדי להריץ את כלי הפריסה של Apigee, נדרש Python. ‫Python נמצא ברוב סביבות Linux, במחשב Mac עם XCode מותקן, במחשב Windows עם Cygwin מותקן ובמקומות רבים אחרים.

כדי להוריד את Python, אפשר לעבור אל דף ההורדה של Python.
curl סקריפטים לדוגמה להגדרה משתמשים גם ב-curl. מוודאים ש-curl מותקן וזמין בנתיב (מריצים את הפקודה which curl כדי לראות אם הוא זמין במערכת).
dos2unix אם אתם מריצים את Cygwin ב-Windows, יכול להיות שתצטרכו גם את כלי השירות dos2unix. (תוכנת ההתקנה של Cygwin מאפשרת להתקין את כלי השירות).

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

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

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

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

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

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

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

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

הפעלת ה-API proxies לדוגמה

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

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

sh invoke.sh

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

פתרון בעיות

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

שינוי של קובצי ה-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>

וששירות ה-Backend שלכם זמין בכתובת 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.