תחילת העבודה עם Cloud Endpoints בסביבה הגמישה של App Engine‏ (‎.NET) באמצעות ESP

במדריך הזה נסביר איך להגדיר ולפרוס API לדוגמה של .NET Core ואת Extensible Service Proxy‏ (ESP) שפועל במופע בסביבה הגמישה של App Engine. ממשק ה-API לדוגמה מתואר באמצעות מפרט OpenAPI. במדריך מוסבר גם איך ליצור מפתח API ולהשתמש בו בבקשות ל-API.

סקירה כללית של Cloud Endpoints זמינה במאמרים מידע על Endpoints וארכיטקטורת Endpoints.

מטרות

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

1. מגדירים Google Cloud פרויקט, מתקינים את התוכנה הנדרשת ויוצרים אפליקציית App Engine. לפני שמתחילים
2. מורידים את הקוד לדוגמה. איך מקבלים את הקוד לדוגמה
3. מגדירים את הקובץ openapi.yaml, שמשמש להגדרת נקודות קצה. איך מגדירים נקודות קצה
4. פורסים את ההגדרה של Endpoints כדי ליצור שירות Endpoints. איך פורסים את ההגדרה של נקודות הקצה
5. פורסים את ה-API ואת ESP לדוגמה ב-App Engine. מידע נוסף זמין במאמר בנושא פריסת קצה העורפי של ה-API.
6. שליחת בקשה ל-API. שליחת בקשה ל-API
7. מעקב אחר פעילות ב-API. מידע נוסף זמין במאמר בנושא מעקב אחר פעילות של API.
8. כדי להימנע מחיובים בחשבון Google Cloud , מידע נוסף זמין בקטע הסרת המשאבים.

עלויות

במסמך הזה משתמשים ברכיבים הבאים של Google Cloud, והשימוש בהם כרוך בתשלום:

• App Engine
• Endpoints

כדי להעריך את ההוצאות בהתאם לתחזית השימוש שלכם, אתם יכולים להיעזר במחשבון העלויות.

משתמשים חדשים של Google Cloud ? יכול להיות שאתם זכאים לתקופת ניסיון בחינם.

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

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

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

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

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

1. חשוב לרשום את מזהה הפרויקט כי תצטרכו אותו בהמשך.
2. כדי לבצע את המדריך הזה, צריך את NET Core 2.x SDK, שאפשר להשתמש בו עם כל עורך טקסט. לא צריך להשתמש בסביבת פיתוח משולבת (IDE), אבל כדי שיהיה לכם נוח, מומלץ להשתמש באחת מסביבות הפיתוח המשולבות הבאות:
   • ‫ Visual Studio Code, שפועל ב-macOS, ב-Linux וב-Windows. אם אתם משתמשים ב-Visual Studio Code, אתם צריכים גם להתקין את ‎.NET Core 2.x.
   • ‫ Visual Studio 2017 ל-Windows, שכולל את ‎ .NET Core 2.x.
   • ‫Visual Studio for Mac, שכולל את ‎ .NET Core 2.x.

3. אתם צריכים אפליקציה כדי לשלוח בקשות ל-API לדוגמה. במדריך הזה מוצג לדוגמה שימוש ב-Invoke-WebRequest, שנתמך ב-PowerShell 3.0 ואילך.

4. הורדה של Google Cloud CLI
5. מעדכנים את ה-CLI של gcloud ומתקינים את רכיבי Endpoints.

   gcloud components update

6. מוודאים ש-Google Cloud CLI ‏ (gcloud) מורשה לגשת לנתונים ולשירותים שלכם ב- Google Cloud:

   gcloud auth login

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

   gcloud config set project YOUR_PROJECT_ID

   מחליפים את YOUR_PROJECT_ID במזהה הפרויקט ב- Google Cloud . אם יש לכם פרויקטים אחרים של Google Cloud ואתם רוצים להשתמש ב-gcloudכדי לנהל אותם, כדאי לעיין במאמר בנושא ניהול ההגדרות האישיות של ה-CLI של gcloud.

8. בוחרים את האזור שבו רוצים ליצור את אפליקציית App Engine. כדי לקבל רשימה של אזורים, מריצים את הפקודה הבאה:

   gcloud app regions list

9. יוצרים אפליקציית App Engine. מחליפים את YOUR_PROJECT_ID במזהה הפרויקט ב- Google Cloudואת YOUR_REGION באזור שבו רוצים ליצור את האפליקציה ב-App Engine.

     gcloud app create \
     --project=YOUR_PROJECT_ID \
     --region=YOUR_REGION
   

קבלת הקוד לדוגמה

כדי להוריד את ה-API לדוגמה:

1. מורידים את קוד הדוגמה כקובץ ZIP.

2. מחלצים את קובץ ה-ZIP ועוברים לספרייה dotnet-docs-samples-master\endpoints\getting-started.

3. פותחים את GettingStarted.sln באמצעות Visual Studio, או משתמשים בעורך המועדף כדי לערוך את הקבצים בספרייה endpoints\getting-started\src\IO.Swagger.

הגדרת נקודות קצה

צריך ליצור מסמך OpenAPI שמבוסס על OpenAPI 2.0 או על OpenAPI 3.x, ומתאר את הסביבה של האפליקציות ואת דרישות האימות. מידע נוסף זמין במאמר גרסאות נתמכות של OpenAPI.

צריך גם להוסיף שדה ספציפי ל-Google שמכיל את כתובת ה-URL של כל אפליקציה, כדי של-ESPv2 יהיה המידע שהוא צריך כדי להפעיל אפליקציה. אם אתם חדשים ב-OpenAPI, תוכלו לקרוא מידע נוסף בסקירה כללית של OpenAPI.

OpenAPI 2.0

כדי להגדיר נקודות קצה באמצעות מפרט OpenAPI 2.0, אפשר להשתמש בקובץ openapi-appengine.yaml שזמין בספרייה dotnet-docs-samples-master\endpoints\getting-started של קוד הדוגמה שהורדתם.

התוכן של מפרט OpenAPI 2.0 צריך להיראות בערך כך:

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR_PROJECT_ID.appspot.com"
consumes:
- "application/json"
produces:
- "application/json"
schemes:
- "https"
paths:
  "/echo":
    post:
      description: "Echo back a given message."
      operationId: "echo"
      produces:
      - "application/json"
      responses:
        200:
          description: "Echo"
          schema:
            $ref: "#/definitions/echoMessage"
      parameters:
      - description: "Message to echo"
        in: body
        name: message
        required: true
        schema:
          $ref: "#/definitions/echoMessage"
      security:
      - api_key: []
  "/auth/info/googlejwt":
    get:
      description: "Returns the requests' authentication information."
      operationId: "auth_info_google_jwt"
      produces:
      - "application/json"
      responses:
        200:
          description: "Authentication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      x-security:
      - google_jwt:
          audiences:
          # This must match the "aud" field in the JWT. You can add multiple
          # audiences to accept JWTs from multiple clients.
          - "echo.endpoints.sample.google.com"
  "/auth/info/googleidtoken":
    get:
      description: "Returns the requests' authentication information."
      operationId: "authInfoGoogleIdToken"
      produces:
      - "application/json"
      responses:
        200:
          description: "Authenication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      x-security:
      - google_id_token:
          audiences:
          # Your OAuth2 client's Client ID must be added here. You can add
          # multiple client IDs to accept tokens from multiple clients.
          - "YOUR-CLIENT-ID"

definitions:
  echoMessage:
    type: "object"
    properties:
      message:
        type: "string"
  authInfoResponse:
    properties:
      id:
        type: "string"
      email:
        type: "string"

securityDefinitions:
  # This section configures basic authentication with an API key.
  api_key:
    type: "apiKey"
    name: "key"
    in: "query"
  # This section configures authentication using Google API Service Accounts
  # to sign a json web token. This is mostly used for server-to-server
  # communication.
  google_jwt:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    # This must match the 'iss' field in the JWT.
    x-google-issuer: "jwt-client.endpoints.sample.google.com"
    # Update this with your service account's email address.
    x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR-SERVICE-ACCOUNT-EMAIL"
  # This section configures authentication using Google OAuth2 ID Tokens.
  # ID Tokens can be obtained using OAuth2 clients, and can be used to access
  # your API on behalf of a particular user.
  google_id_token:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    x-google-issuer: "https://accounts.google.com"
    x-google-jwks_uri: "https://www.googleapis.com/oauth2/v1/certs"

בשורה עם שדה המארח, מחליפים את YOUR_PROJECT_ID במזהה הפרויקט שלכם ב- Google Cloud .

‫OpenAPI 3.x

כדי להגדיר את Endpoints באמצעות מפרט OpenAPI 3.x, אפשר להחליף את התוכן של הקובץ openapi-appengine.yaml שזמין בספרייה dotnet-docs-samples-master\endpoints\getting-started של קוד הדוגמה שהורדתם:

1. פותחים את הקובץ openapi-appengine.yaml בכלי לעריכת טקסט ומחליפים את התוכן שלו בתוכן הבא:

   openapi: 3.0.4
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   servers:
     - url: "https://YOUR_PROJECT_ID.appspot.com"
       x-google-endpoint: {}
   paths:
     "/echo":
       post:
         description: "Echo back a given message."
         operationId: "echo"
         requestBody:
           description: "Message to echo"
           required: true
           content:
             "application/json":
               schema:
                 $ref: "#/components/schemas/echoMessage"
         responses:
           "200":
             description: "Echo"
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/echoMessage"
         security:
           - api_key: []
     "/auth/info/googlejwt":
       get:
         description: "Returns the requests' authentication information."
         operationId: "auth_info_google_jwt"
         responses:
           "200":
             description: "Authenication info."
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/authInfoResponse"
         security:
           - google_jwt: []
     "/auth/info/googleidtoken":
       get:
         description: "Returns the requests' authentication information."
         operationId: "authInfoGoogleIdToken"
         responses:
           "200":
             description: "Authenication info."
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/authInfoResponse"
         security:
           - google_id_token: []
   
   components:
     schemas:
       echoMessage:
         type: "object"
         properties:
           message:
             type: "string"
       authInfoResponse:
         type: "object"
         properties:
           id:
             type: "string"
           email:
             type: "string"
   
     securitySchemes:
       # This section configures basic authentication with an API key.
       api_key:
         type: apiKey
         name: key
         in: query
       # This section configures authentication using Google API Service Accounts
       # to sign a json web token. This is mostly used for server-to-server
       # communication.
       google_jwt:
         type: oauth2
         flows:
           implicit:
             authorizationUrl: ""
             scopes: {}
         x-google-auth:
           issuer: "jwt-client.endpoints.sample.google.com"
           jwksUri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR_SERVICE_ACCOUNT_EMAIL"
           audiences:
             - "echo.endpoints.sample.google.com"
           # This must match the "aud" field in the JWT. You can add multiple
           # audiences to accept JWTs from multiple clients.
       # This section configures authentication using Google OAuth2 ID Tokens.
       # ID Tokens can be obtained using OAuth2 clients, and can be used to access
       # your API on behalf of a particular user.
       google_id_token:
         type: oauth2
         flows:
           implicit:
             authorizationUrl: ""
             scopes: {}
         x-google-auth:
           issuer: "https://accounts.google.com"
           jwksUri: "https://www.googleapis.com/oauth2/v1/certs"
           audiences:
             - "YOUR_CLIENT_ID"

2. שומרים את התוכן החדש של openapi.yaml.

הערה: קובץ הדוגמה openapi-appengine.yaml מכיל קטע להגדרת אימות שלא נדרש במדריך הזה. אין צורך להגדיר את השורות עם YOUR_SERVICE_ACCOUNT_EMAIL ועם YOUR_CLIENT_ID.

במדריך הזה נעשה שימוש בתוסף ספציפי ל-Google למפרט OpenAPI, שמאפשר להגדיר את שם השירות. השיטה לציון שם השירות תלויה בגרסה של מפרט OpenAPI שבה אתם משתמשים.

OpenAPI 2.0

משתמשים בשדה host כדי לציין את שם השירות:

host: YOUR_PROJECT_ID.appspot.com

כדי להגדיר נקודות קצה:

1. פותחים את הקובץ openapi-appengine.yaml.
2. בשדה host, מחליפים את YOUR_PROJECT_ID במזהה הפרויקט ב- Google Cloud .
3. שומרים את קובץ ה-openapi-appengine.yaml.

‫OpenAPI 3.x

משתמשים בשדה url באובייקט servers כדי לציין את שם השירות:

servers:
- url: https://YOUR_PROJECT_ID.appspot.com
  x-google-endpoint: {}

כדי להגדיר נקודות קצה:

1. פותחים את הקובץ openapi-appengine.yaml.
2. אם בקובץ openapi-appengine.yaml יש שדה host, צריך להסיר אותו.
3. מוסיפים אובייקט servers כמו שמוצג.
4. בשדה url, מחליפים את YOUR_PROJECT_ID במזהה הפרויקט ב- Google Cloud .
5. שומרים את קובץ ה-openapi-appengine.yaml.

הערה: כדי לציין את כתובת ה-URL הנכונה לשימוש השרתים, צריך לכלול את x-google-endpoint: {} באובייקט server. אפשר לכלול ברשימה הזו שרתים אחרים, אבל בדיוק לאחד מהם צריך להיות x-google-endpoint: {} כדי לציין את השרת הנכון. המערכת תתעלם מכל השאר.

פריסת ההגדרה של נקודות הקצה

כדי לפרוס את ההגדרה של Endpoints, משתמשים בפקודה gcloud endpoints services deploy. הפקודה הזו משתמשת ב-Service Management כדי ליצור שירות מנוהל.

כדי לפרוס את ההגדרה של Endpoints:

1. מוודאים שאתם נמצאים בספרייה שבה נמצא קובץ ההגדרות openapi.yaml.
2. מעלים את ההגדרה ויוצרים שירות מנוהל:

   gcloud endpoints services deploy openapi.yaml
   

הפקודה gcloud קוראת ל-Service Management API כדי ליצור שירות מנוהל עם השם שציינתם בשדה host או servers.url בקובץ openapi.yaml. שירות ניהול השירותים מגדיר את השירות בהתאם להגדרות בקובץ openapi.yaml. כשמבצעים שינויים ב-openapi.yaml, צריך לפרוס מחדש את הקובץ כדי לעדכן את שירות נקודות הקצה.

במהלך היצירה וההגדרה של השירות, Service Management מציג מידע במסוף. אפשר להתעלם בבטחה מהאזהרות לגבי הנתיבים בקובץ openapi.yaml שלא דורשים מפתח API. בסיום הגדרת השירות, Service Management מציג הודעה עם מזהה הגדרת השירות ושם השירות, בדומה להודעה הבאה:

Service Configuration [2017-02-13r0] uploaded for service [example-project-12345.appspot.com]

בדוגמה שלמעלה, 2017-02-13r0 הוא מזהה הגדרת השירות ו-example-project-12345.appspot.com הוא שירות ה-Endpoints. מזהה הגדרות השירות מורכב מחותמת תאריך וממספר גרסה. אם תפעילו את הקובץ openapi.yaml שוב באותו יום, מספר הגרסה יוגדל במזהה תצורת השירות. אפשר לראות את הגדרת השירות של Endpoints בדף Endpoints > Services במסוף Google Cloud .

אם מופיעה הודעת שגיאה, אפשר לעיין במאמר בנושא פתרון בעיות בהטמעה של הגדרות Endpoints.

בדיקת השירותים הנדרשים

לפחות, צריך להפעיל את שירותי Google הבאים כדי להשתמש ב-Endpoints וב-ESP:

שם	כותרת
servicemanagement.googleapis.com	Service Management API
servicecontrol.googleapis.com	Service Control API

ברוב המקרים, הפקודה gcloud endpoints services deploy מפעילה את השירותים הנדרשים האלה. עם זאת, הפקודה gcloud מסתיימת בהצלחה אבל לא מפעילה את השירותים הנדרשים בנסיבות הבאות:

• אם השתמשתם באפליקציה של צד שלישי כמו Terraform ולא כללתם את השירותים האלה.

• הפריסה של הגדרת ה-Endpoints בוצעה בפרויקטGoogle Cloud קיים שבו השירותים האלה הושבתו באופן מפורש.

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

gcloud services list

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

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

צריך גם להפעיל את שירות Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

כדי לדעת מהו ENDPOINTS_SERVICE_NAME, אפשר:

• אחרי פריסת ההגדרה של Endpoints, נכנסים לדף Endpoints במסוף Cloud. רשימת האפשרויות האפשריות של ENDPOINTS_SERVICE_NAME מוצגת בעמודה שם השירות.

• ב-OpenAPI, ‏ ENDPOINTS_SERVICE_NAME הוא הערך שציינתם בשדה host במפרט OpenAPI. ב-gRPC, ‏ ENDPOINTS_SERVICE_NAME הוא הערך שציינתם בשדה name בהגדרות של נקודות הקצה של gRPC.

מידע נוסף על פקודות gcloud זמין במאמר שירותי gcloud.

פריסת ה-API backend

עד עכשיו פרסתם את מסמך ה-OpenAPI ב-Service Management, אבל עדיין לא פרסתם את הקוד שמפעיל את ה-backend של ה-API. בקטע הזה מוסבר איך פורסים את ה-API ואת ה-ESP לדוגמה ב-App Engine.

כדי לפרוס את העורף של ה-API:

1. פותחים את הקובץ endpoints/getting-started/src/IO.Swagger/app.yaml ומוסיפים את שם השירות:
endpoints_api_service:
  # The following values are to be replaced by information from the output of
  # 'gcloud endpoints services deploy openapi-appengine.yaml' command. If you have
  # previously run the deploy command, you can list your existing configuration
  # ids using the 'configs list' command as follows:
  # 'gcloud endpoints configs list --service=[PROJECT-ID].appspot.com'
  # where [PROJECT-ID].appspot.com is your Endpoints service name.
  name: ENDPOINTS-SERVICE-NAME
  rollout_strategy: managed

מחליפים את ENDPOINTS-SERVICE-NAME בשם של שירות Endpoints. זהו אותו שם שהגדרתם בשדה host במסמך OpenAPI. לדוגמה:

endpoints_api_service:
  name: example-project-12345.appspot.com
  rollout_strategy: managed

האפשרות rollout_strategy: managed מגדירה את ESP כך שישתמש בהגדרת השירות העדכנית ביותר שנפרסה. אם תבחרו באפשרות הזו, עד 5 דקות אחרי שתפרסו הגדרת שירות חדשה, ESP יזהה את השינוי ויתחיל להשתמש בה באופן אוטומטי. אנחנו ממליצים לציין את האפשרות הזו במקום מזהה תצורה ספציפי לשימוש ב-ESP.

2. שומרים את קובץ ה-app.yaml.

מכיוון שהקטע endpoints_api_service כלול בקובץ app.yaml, הפקודה gcloud app deploy פורסת ומגדירה את ESP במאגר נפרד מסביבת App Engine הגמישה. כל תעבורת הבקשות מנותבת דרך ESP, והוא משמש כפרוקסי לבקשות ולתגובות אל הקונטיינר שבו פועל קוד שרת הקצה העורפי וממנו.

3. מוודאים שאתם נמצאים בספרייה endpoints/getting-started, שבה נמצא קובץ ההגדרות openapi.yaml.
4. פורסים את ה-API ואת ה-ESP לדוגמה ב-App Engine:

     dotnet restore
       dotnet publish
       gcloud app deploy src\IO.Swagger\bin\Debug\netcoreapp2.0\publish\app.yaml
   

   הפקודה gcloud app deploy יוצרת רשומת DNS בפורמט YOUR_PROJECT_ID.appspot.com, שמשמשת לשליחת בקשות ל-API. מומלץ להמתין כמה דקות לפני שליחת בקשות ל-API בזמן שהאפליקציה עוברת אתחול מלא ב-App Engine.

אם מופיעה הודעת שגיאה, אפשר להיעזר במאמר פתרון בעיות בפריסה של App Engine Flexible.

מידע נוסף מופיע במאמר בנושא פריסת קצה העורפי של ה-API.

שליחת בקשות ל-API

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

יצירת מפתח API והגדרת משתנה סביבה

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

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

   לדף Credentials

2. לוחצים על Create credentials ואז על API key.
3. מעתיקים את המפתח ללוח.
4. לוחצים על Close.
5. במחשב המקומי, מדביקים את מפתח ה-API כדי להקצות אותו למשתנה סביבה: $Env:ENDPOINTS_KEY="AIza..."

שליחת הבקשה

1. ב-PowerShell, מגדירים משתנה סביבה לכתובת ה-URL של פרויקט App Engine. מחליפים את YOUR_PROJECT_ID במזהה הפרויקט ב-Google Cloud .

   $Env:ENDPOINTS_HOST="https://YOUR_PROJECT_ID.appspot.com"

2. בודקים בקשת HTTP באמצעות משתני הסביבה ENDPOINTS_HOST ו-ENDPOINTS_KEY שהגדרתם קודם:

   Invoke-WebRequest "$ENDPOINTS_HOST/echo?key=$ENDPOINTS_KEY" `
     -Body '{"message": "hello world"}' -Method POST `
     -ContentType "application/json"
   

בדוגמה הקודמת, שתי השורות הראשונות מסתיימות בגרש הפוך. כשמדביקים את הדוגמה ב-PowerShell, צריך לוודא שאין רווח אחרי התווים '`'. מידע על האפשרויות שבהן נעשה שימוש בבקשת הדוגמה מופיע במאמר Invoke-WebRequest במסמכי התיעוד של מיקרוסופט.

ה-API מחזיר את ההודעה ששלחתם לו, ומגיב עם:

{
  "message": "hello world"
}

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

הרגע פרסתם ובדקתם API ב-Endpoints!

הערה: אם אתם רוצים לספר לנו מה אהבתם במדריך הזה, אתם יכולים לשלוח משוב בתחתית הדף. המשוב שלכם עוזר לנו לשפר את המדריכים האלה.
אם קיבלתם שגיאה, הצטרפו לgoogle-cloud-endpointsקבוצת Google וספרו לנו מה השתבש. הקבוצה הזו מקבלת תשובות ממשתמשי Endpoints אחרים ומהמהנדסים של Google שעוקבים אחרי הקבוצה.

מעקב אחר פעילות ב-API

1. אפשר לראות את הגרפים של הפעילות ב-API בדף Endpoints (נקודות קצה).

   לדף Endpoints Services

   יכול להיות שיעברו כמה רגעים עד שהבקשה תשתקף בתרשימים.

2. מעיינים ביומני הבקשות של ה-API בדף Logs Explorer.

   כניסה לדף Logs Explorer

הסרת המשאבים

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

הסרת המשאבים

במאמר מחיקת API ומופעי API מוסבר איך להפסיק את השירותים שבהם נעשה שימוש במדריך הזה.

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

• שיתוף ה-API עם מפתח אחר
• מידע נוסף על אימות
• מידע על אפשרויות תמיכה קהילתית