פריסה ובדיקה של API

בדף הזה מוסבר איך לפרוס את ה-API.

לפני שמתחילים

פריסת ה-API בסביבת הייצור

כדי לפרוס API:

  1. מגדירים את משתנה הסביבה ENDPOINTS_GAE_SDK לנתיב של תיקיית App Engine SDK: Path_to_Cloud_SDK/platform/google_appengine.

    מחליפים את Path_to_Cloud_SDK בפלט של הפקודה הבאה:

     gcloud info --format="value(installation.sdk_root)"

  2. מריצים את הפקודה הבאה בספרייה הראשית של ה-API:

     gcloud app deploy

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

    File upload done.
Updating service [default]...done.

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

    curl --request POST \
   --header "Content-Type: application/json" \
   --data '{"content":"echo"}' \
   https://PROJECT_ID.appspot.com/_ah/api/echo/v1/echo?n=2

    מחליפים את PROJECT_ID במזהה הפרויקט ואת echo בשם ה-API.

    התוצאות:

    {
 "content": "echo echo"
}

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

פריסה למספר גרסאות של אפליקציות

מידע על ניהול גרסאות של API ועל פריסה לגרסאות זמין במאמר ניהול גרסאות של API

בדיקה של API באופן מקומי

אתם יכולים להשתמש בשרת הפיתוח המקומי של App Engine כדי לבדוק את ה-API באופן מקומי. מידע נוסף על שרת הפיתוח המקומי זמין במאמר שימוש בשרת הפיתוח המקומי.

כדי להריץ את ה-API באופן מקומי:

  1. מתיקיית השורש של הפרויקט, מפעילים את שרת הפיתוח של App Engine:

    dev_appserver.py YOUR_PROJECT_DIR

  2. מריצים את הפקודה curl כדי לשלוח בקשת API, לדוגמה:

     curl --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"echo"}' \
    "${HOST}/_ah/api/echo/v1/echo?n=2"

הוספת ניהול API

‫Endpoints Frameworks מספק תכונות לניהול API, כמו:

כדי שממשק ה-API שלכם ינוהל על ידי Endpoints Frameworks, אתם צריכים ליצור ולפרוס מסמך OpenAPI שמתאר את ממשק ה-API, כמו שמתואר במאמר הוספת ניהול API.