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

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

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

פריסת API

אפשר לפרוס את ה-API באמצעות התוספים Apache Maven או Gradle של App Engine. כדי לפרוס את ה-API בסביבת ייצור רגילה של App Engine, משתמשים בפקודה של הפלאגין:

  1. משתמשים בפקודה של הפלאגין:

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy
  2. ממתינים עד שהפריסה תסתיים.

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

    curl \
    -H "Content-Type: application/json" \
    -X POST \
    -d '{"message": "echo"}' \
    "https://YOUR-PROJECT-ID.appspot.com/_ah/api/echo/v1/echo?n=2"

    התגובה אמורה להיות דומה לזו:

    {
  "message": "echo echo"
}

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

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

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

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

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

  1. יוצרים את הפרויקט בספריית השורש של הפרויקט. לדוגמה:

    Maven

    mvn clean package

    Gradle

    gradle clean build

  2. מפעילים את שרת הפיתוח של App Engine. לדוגמה:

    Maven

    mvn appengine:run

    Gradle

    gradle appengineRun

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

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

הצגת ה-API מנתיב אחר

כדי להציג את ה-API מנתיב אחר, בקובץ web.xml, משנים את url-pattern בקטע EndpointsServlet ומבצעים פריסה מחדש של ה-API. לדוגמה:

<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/example-api/*</url-pattern>
</servlet-mapping>

הוספת ניהול API

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

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