יצירת proxy ל-API

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

יוצרים שרת proxy בממשק המשתמש של Apigee או באמצעות ה-API, כמו שמתואר בקטעים הבאים.

שדות ראשיים של proxy ל-API

כשיוצרים proxy ל-API, צריך לפעול לפי ההנחיות הבאות:

שדה תיאור
שם ה-proxy ל-API השם שמוצג עבור ה-API. צריך לציין תווים אלפאנומריים, מקף (-) או קו תחתון (_).
נתיב בסיס של proxy ל-API מקטע URI שמופיע אחרי הכתובת http://[host] או https://[host] של proxy ה-API. ‫Apigee משתמש ב-URI של נתיב הבסיס כדי להתאים ולנתב הודעות בקשה נכנסות אל ה-proxy ל-API המתאים.

שימוש בתווים כלליים בנתיבי בסיס

כדי להגן על שרתי ה-proxy ל-API מפני שינויים עתידיים, כדאי להשתמש בתו כללי אחד או יותר בנתיבי הבסיס של שרתי ה-proxy ל-API. אנחנו מאפשרים לציין תו כללי יחיד * בין שני תווים של לוכסן /: /*/. לדוגמה, נתיב בסיסי של /team/*/members מאפשר ללקוחות לבצע קריאה ל-https://[host]/team/blue/members ול-https://[host]/team/green/members בלי שתצטרכו ליצור שרתי proxy חדשים של API כדי לתמוך בצוותים חדשים. אפשר להחליף כל מספר של טוקנים בנתיב הבסיסי לפי התבנית הזו. אין תמיכה בדפוסים אחרים, כולל /**, /something* או /*something.
תיאור (אופציונלי). תיאור של שרת ה-proxy ל-API.
כתובת URL של יעד/יעד בקצה העורפי כתובת ה-URL (כולל HTTP או HTTPS) של שירות לקצה העורפי שה-proxy ל-API הזה מפעיל.
מרחב (אופציונלי) אם בארגון שלכם מופעל Apigee Spaces, אתם יכולים לשייך את ה-proxy ל-API למרחב. מידע נוסף זמין במאמר סקירה כללית של Apigee Spaces.

שלבים ליצירת proxy ל-API

כדי ליצור proxy ל-API באמצעות ממשק המשתמש או ממשקי API:

ממשק המשתמש של Apigee

כדי ליצור שרת proxy בממשק המשתמש של Apigee:

  1. במסוף Google Cloud , נכנסים לדף Apigee > Proxy development > API proxies.

    מעבר לשרתי proxy ל-API

  2. בחלונית API Proxies (שרתי proxy של API), לוחצים על + Create (יצירה).
  3. בחלונית Create a proxy (יצירת שרת proxy), בקטע Proxy template (תבנית שרת proxy), בוחרים באפשרות Reverse proxy (Most common) (שרת proxy הפוך (הנפוץ ביותר)).
  4. בקטע פרטי שרת proxy, מזינים את הפרטים הבאים:
    • שם ה-proxy: מזינים שם ל-proxy, למשל myproxy.
    • נתיב בסיס: מוגדר אוטומטית לערך שמזינים עבור Proxy name. נתיב הבסיס הוא חלק מכתובת ה-URL שמשמשת לשליחת בקשות ל-API. ‫Apigee משתמש בכתובת ה-URL כדי להתאים בקשות נכנסות ולנתב אותן אל proxy ה-API המתאים.
    • תיאור (אופציונלי): מזינים תיאור ל-proxy ל-API החדש, למשל "בדיקת Apigee באמצעות proxy פשוט".
    • יעד (API קיים): מזינים https://mocktarget.apigee.net. ההגדרה הזו מגדירה את כתובת ה-URL של היעד שאליו Apigee קורא בבקשה ל-proxy ל-API. שירות mocktarget מתארח ב-Apigee ומחזיר נתונים פשוטים. לא נדרש מפתח API או טוקן גישה.
    • מרחב (אופציונלי): אם הארגון שלכם הפעיל את Apigee Spaces, אתם יכולים לשייך את ה-proxy ל-API למרחב שנבחר מתוך רשימת האפשרויות הזמינות. מידע נוסף זמין במאמר סקירה כללית של Apigee Spaces.
    • לוחצים על הבא.
  5. פריסה (אופציונלי):
    • סביבות פריסה: אופציונלי. משתמשים בתיבות הסימון כדי לבחור סביבה אחת או יותר שבהן רוצים לפרוס את ה-proxy. אם אתם לא רוצים לפרוס את ה-proxy בשלב הזה, אתם יכולים להשאיר את השדה סביבות פריסה ריק. תמיד אפשר לפרוס את ה-proxy מאוחר יותר.
    • חשבון שירות: אופציונלי. מצרפים חשבון שירות לפריסה כדי לאפשר לשרת ה-proxy לגשת לשירותים, כמו שצוין בתפקיד ובהרשאות של חשבון השירות. Google Cloud
  6. לוחצים על יצירה.

‫Apigee יוצר את ה-proxy החדש ומציג סיכום של פרטי ה-proxy בתצוגה Proxy summary.

חלונית הסיכום של myproxy.

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

Apigee API

יוצרים proxy ל-API בארגון Apigee על ידי שליחת בקשת POST למשאב הבא:

https://apigee.googleapis.com/v1/organizations/$ORG/apis

צריך להגדיר את השם של proxy ל-API באמצעות פרמטר השאילתה name. הגבלת התווים שמשמשים בשם לאלה: A-Za-z0-9._\-$ %

אופציונלי: אפשר לייבא חבילת הגדרות של שרת proxy ל-API באופן הבא:

  • מגדירים את פרמטר השאילתה action לערך import
  • מגדירים את הכותרת Content-type ל-multipart/form-data
  • מעבירים את השם של חבילת ההגדרות של proxy ל-API במערכת הקבצים המקומית

בדוגמה הבאה מוצג איך ליצור שרת proxy ל-API על ידי ייבוא חבילת הגדרות של שרת proxy ל-API‏ (helloworld-config.zip) במערכת הקבצים המקומית באמצעות ה-API.

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis?name=helloworld&action=import" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: multipart/form-data" \
  -F "file=@helloworld-config.zip"

‫$TOKEN מוגדר לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

זוהי דוגמה לפלט התגובה:

{
  "basepaths": [
    "/helloworld"
  ],
  "configurationVersion": {
    "majorVersion": 4
  },
  "createdAt": "1559145292799",
  "displayName": "helloworld",
  "entityMetaDataAsProperties": {
    "bundle_type": "zip",
    "subType": "Proxy",
    "lastModifiedAt": "1559145292799",
    "createdAt": "1559145292799"
  },
  "lastModifiedAt": "1559145292799",
  "name": "helloworld",
  "policies": [
    "verify-api-key",
    "remove-query-param-apikey",
    "OAuth-v20-1"
  ],
  "proxies": [
    "default"
  ],
  "proxyEndpoints": [
    "default"
  ],
  "resourceFiles": {},
  "targetEndpoints": [
    "default"
  ],
  "targets": [
    "default"
  ],
  "type": "Application",
  "revision": "1",
  "description": "Hello world"
}

מידע נוסף על יצירת proxy ל-API זמין במאמר בנושא שיטת apis.create ב-Apigee API. כדי לראות את כל השיטות שזמינות לשרתי proxy ל-API, אפשר לעיין במאמר בנושא API של שרתי proxy ל-API.

השלבים הבאים

אחרי שיוצרים proxy ל-API פשוט, בדרך כלל מבצעים אחת מהפעולות הבאות: