יצירת API

בדף הזה מוסבר איך ליצור API.

דרישות מוקדמות

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

דרישות לגבי מזהה API

בפקודות רבות של gcloud שמוצגות כאן צריך לציין את מזהה ה-API, בפורמט: API_ID. API Gateway אוכף את הדרישות הבאות לגבי מזהה ה-API:

  • האורך המקסימלי הוא 63 תווים.
  • השם צריך להכיל רק אותיות קטנות, מספרים או מקפים.
  • השם לא יכול להתחיל במקף.
  • אסור להכיל קו תחתון.

יצירת API

יוצרים API.

מסוףGoogle Cloud

יוצרים ופורסים API, כמו שמתואר במאמר פריסת API בשער.

Google Cloud CLI

כדי ליצור API, כדאי לעיין בקטעים הבאים:

השלבים ליצירת API

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

    gcloud config list project

    אם אתם צריכים לשנות את פרויקט ברירת המחדל, מריצים את הפקודה הבאה ומחליפים את PROJECT_ID במזהה הפרויקט שבו אתם רוצים ליצור את השירות: Google Cloud 

    gcloud config set project PROJECT_ID

    אם מזהה הפרויקט מכיל נקודתיים (:), כדאי לעיין בפרויקטים בהיקף הדומיין כדי לקבל פרטים נוספים על יצירת API בפרויקט.

  2. הצגת העזרה עבור הפקודה apis create:

    gcloud api-gateway apis create --help

  3. מריצים את הפקודה הבאה כדי ליצור את ה-API:

    gcloud api-gateway apis create API_ID

    where:

    • ‫API_ID מציין את המזהה של ה-API החדש. הנחיות למתן שמות ל-API מופיעות במאמר בנושא דרישות לגבי מזהה API.

    במהלך יצירת ה-API, ‏ API Gateway מוציא פלט של מידע למסוף.

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

    gcloud api-gateway apis describe API_ID

    הפקודה הזו מחזירה את הפלט הבא:

          createTime: '2020-02-29T21:52:20.297426875Z'
      displayName: API_ID
      managedService: MANAGED_SERVICE_NAME.apigateway.PROJECT_ID.cloud.goog
      name: projects/PROJECT_ID/locations/global/apis/API_ID
      state: ACTIVE
      updateTime: '2020-02-29T21:52:20.647923711Z'

אפשרויות של Google Cloud CLI

‫Google Cloud CLI מקבל הרבה אפשרויות, כולל אלה שמתוארות במדריך העזר ל-gcloud. בנוסף, כשיוצרים API ב-API Gateway, אפשר להגדיר את האפשרויות הבאות:

  • ‫--async: החזרת השליטה למסוף באופן מיידי, בלי להמתין לסיום הפעולה.
  • ‫--display-name=NAME: מציין את השם המוצג של ה-API, כלומר השם שמוצג בממשק המשתמש. לא להשתמש ברווחים בשם. במקום זאת, אפשר להשתמש במקפים ובקווים תחתונים. ערך ברירת המחדל הוא API_ID.
  • ‫--labels=KEY1=VALUE1,KEY2=VALUE2,...: מציין את התוויות שמשויכות להגדרת ה-API.
  • ‫--managed-service: מציין שירות מנוהל קיים מראש עבור ה-API. אפשר לעיין גם במאמר בנושא פרויקטים בהיקף דומיין

פרויקטים בהיקף הדומיין

אם הפרויקט מוגבל לדומיין שלכם, מזהה הפרויקט כולל את שם הדומיין ואחריו נקודתיים (:), לדוגמה, example.com:my-project. כשיוצרים API בפרויקט בהיקף דומיין, צריך לספק שירות מנוהל תקין.

אם משתמשים ב-gcloud, צריך לספק את שם השירות המנוהל באמצעות הדגל --managed-service, כמו שמתואר באפשרויות של Google Cloud CLI.

ממשקי API של רשימות

הצגת רשימה של כל ממשקי ה-API בפרויקט.

מסוףGoogle Cloud

נכנסים לדף API Gateway במסוף Google Cloud .

ל-API Gateway

Google Cloud CLI

gcloud api-gateway apis list

הפלט של הפקודה הזו הוא מהצורה:

  NAME                                              DISPLAY_NAME  MANAGED_SERVICE                          STATE
  projects/PROJECT_ID/locations/global/apis/API_ID  API_ID        MANAGED_SERVICE_NAME.apigateway.PROJECT_ID.cloud.goog  ACTIVE

משתמשים במזהה ה-API כדי לקבל מידע מפורט על ה-API:

gcloud api-gateway apis describe API_ID

עדכון API

אחרי שיוצרים API, אפשר לעדכן את התוויות והשם המוצג שלו.

מסוףGoogle Cloud

  1. נכנסים לדף API Gateway במסוף Google Cloud .

    ל-API Gateway

  2. לוחצים על ממשק ה-API הנדרש.
  3. לוחצים על הכרטיסייה פרטים.
  4. לוחצים על עריכה עריכה.
  5. עורכים את השם המוצג או את התוויות ולוחצים על שמירה.

Google Cloud CLI

משתמשים באפשרויות הבאות של gcloud כדי לעדכן API קיים:

  • --display-name
  • --update-labels
  • --clear-labels
  • --remove-labels

לדוגמה:

  gcloud api-gateway apis update API_ID \
    --update-labels=a=1,b=2

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

gcloud api-gateway apis update --help

מחיקת API

כדי למחוק API, צריך:

  • מוחקים את נכסי API Gateway שמשויכים ל-API ולהגדרות ה-API שלו.
  • מוחקים את הגדרות ה-API שמשויכות ל-API.
  • מוחקים את ה-API.

מסוףGoogle Cloud

  1. נכנסים לדף API Gateway במסוף Google Cloud .

    ל-API Gateway

  2. לוחצים על ה-API שנבחר למחיקה.
  3. לוחצים על הכרטיסייה Configs.
  4. בוחרים את הגדרות ה-API ולוחצים על עוד ואז על מחיקה.
  5. לוחצים על כדי לחזור לדף הבית של API Gateway.
  6. לוחצים על סמל האפשרויות הנוספות ואז על מחיקה כדי למחוק את ה-API שנבחר.

Google Cloud CLI

  1. קובעים את רשימת ה-API Gateways שמשויכים ל-API:

    gcloud api-gateway gateways list --filter='apiConfig:"projects/PROJECT_ID/locations/global/apis/API_ID"'

  2. מוחקים כל הגדרת API שמשויכת ל-API:

    gcloud api-gateway api-configs delete CONFIG_ID --api=API_ID

  3. מחיקת ה-API:

    gcloud api-gateway apis delete API_ID

המאמרים הבאים