必要的檔案與設定

您的專案至少必須包含下列檔案：

檔案和位置 說明
/src/<your_api_class>.py 包含後端 API 的類別檔案 (如果您在多個類別實作 API，則會有多個類別檔案)。
/src/<your_api_server>.py 包含 API 伺服器程式碼的檔案 (選用，如果 API 類別中沒有 API 伺服器程式碼)。
/src/app.yaml App Engine 設定所需的網頁應用程式 deployment descriptor。

以下各節說明各必要檔案的內容。

API 類別檔案

如需類別檔案 (如果您使用多類別 API 則為多個類別檔案) 必要和選用內容的完整說明，請瀏覽建立 Endpoints API 主題。

API 伺服器檔案

如需 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

其中：

  • main 是 API 伺服器的 Python 模組與變數名稱。
  • 如果希望 App Engine 同時傳送多個要求，請將 threadsafe 設為「true」；如果想讓 App Engine 依序傳送要求，則請設為「false」。

您還可使用額外的選用設定。如要進一步瞭解，請參閱 app.yaml 參考資料。但請注意，「需要登入或系統管理員狀態」和「安全的網址」下方的資訊不適用於後端 API。