עריכת proxy ל-API (יצירת גרסת proxy)

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

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

מידע נוסף
מידע נוסף זמין במאמרים הבאים:

• שיטות מומלצות לתכנון ולפיתוח של proxy ל-API

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

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

1. שמירת השינויים בשרת בלי ליצור גרסה חדשה. האפשרות הזו שימושית אם אתם לא רוצים לפרוס את השינויים ששמרתם, אלא רק לוודא שהם לא יימחקו אם תסיימו את הסשן.
   

   או

2. יוצרים גרסה חדשה של proxy ל-API ומציבים אותה באשכול. אי אפשר לפרוס שינויים ב-proxy ל-API בלי ליצור גרסה חדשה שלו.

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

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

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

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

2. ברשימת השרתים הפרוקסי, בוחרים את השרת הפרוקסי שרוצים לערוך. בממשק המשתמש מוצגת הכרטיסייה סקירה כללית של ה-proxy במסוף Google Cloud .

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

     

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

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.

export TOKEN=$(gcloud auth print-access-token)
export ORG=ORGANIZATION_NAME
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.