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

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

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

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

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

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

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

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

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

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

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

לדוגמה, כדי להוסיף מדיניות, לוחצים על הסמל + לצד מדיניות, בוחרים את המדיניות שרוצים להוסיף, מזינים שם ושם מוצג אופציונלי, לוחצים על יצירה ומגדירים את המדיניות בממשק.
כשמסיימים לבצע שינויים, אפשר לבצע אחת מהפעולות הבאות:
- כדי לשמור את השינויים אבל לא ליצור גרסה חדשה, לוחצים על הלחצן שמירה. (מומלץ לעשות את זה מעת לעת כדי לוודא שהשינויים לא יאבדו אם תסיימו את הסשן).
- כדי לשמור את השינויים כגרסה חדשה (כשמתכוננים לפריסה ולבדיקה), לוחצים על התפריט הנפתח לצד הלחצן שמירה ובוחרים באפשרות שמירה כגרסה חדשה:
  
  ממשק המשתמש של 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.

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

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

Apigee API

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