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

הפרויקט צריך להכיל לפחות את הקבצים הבאים:

קובץ ומיקום תיאור
/src/<your_api_class>.py קובץ הכיתה (או קבצים, אם מטמיעים את ה-API בכמה כיתות) שמכיל את ה-API של ה-Backend.
/src/<your_api_server>.py קובץ אופציונלי שמכיל את קוד שרת ה-API, אם לא כוללים אותו בתוך מחלקת ה-API.
/src/app.yaml קובץ תיאור הפריסה של אפליקציית האינטרנט שנדרש להגדרת App Engine.

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

קובץ המחלקה של ה-API

התוכן הנדרש והאופציונלי של קובץ המחלקה (או הקבצים, אם משתמשים בAPI עם כמה מחלקות) מתואר באופן מלא בנושא יצירת API של Endpoints.

קובץ שרת ה-API

תיאור מלא של הקובץ הזה והתוכן שלו מופיע במאמר בנושא יצירת שרת אינטרנט.

app.yaml

אלה תכני המינימום שנדרשים בקובץ הזה:

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

runtime: python27
threadsafe: true
api_version: 1
basic_scaling:
  max_instances: 2

skip_files:
- ^(.*/)?#.*#$
- ^(.*/)?.*~$
- ^(.*/)?.*\.py[co]$
- ^(.*/)?.*/RCS/.*$
- ^(.*/)?\..*$
- ^(.*/)?setuptools/script \(dev\).tmpl$

handlers:
# The endpoints handler must be mapped to /_ah/api.
- url: /_ah/api/.*
  script: main.api

libraries:
- name: pycrypto
  version: 2.6
- name: ssl
  version: 2.7.11

env_variables:
  # The following values are to be replaced by information from the output of
  # 'gcloud endpoints services deploy swagger.json' command.
  ENDPOINTS_SERVICE_NAME: YOUR-PROJECT-ID.appspot.com
  ENDPOINTS_SERVICE_VERSION: 2016-08-01r0

where:

  • ‫main הוא השם של מודול Python והמשתנה של שרת ה-API.
  • הערך של threadsafe מוגדר כ-true אם רוצים ש-App Engine ישלח כמה בקשות במקביל, או כ-false אם רוצים ש-App Engine ישלח בקשות ברצף.

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