שימוש בשרתי 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 עם 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. צריך לערוך את הקובץ כדי להגדיר את הארגון, את כתובת האימייל המשויכת לשם המשתמש שלך ואת הסביבה (ייצור או בדיקה) שבה רוצים לפרוס את שרתי ה-proxy של ה-API.
4. אחרי שעורכים את setenv.sh, צריך לבצע את הפעולות הבאות:

   sh deploy_all.sh

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

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