File e configurazione richiesti

Il progetto deve contenere, come minimo, i seguenti file:

File e posizione Descrizione
/src/<your_api_class>.py Il file (o i file, se implementi l'API in più classi) della classe contenente l'API di backend.
/src/<your_api_server>.py (Facoltativo) File contenente il codice del server API, se non lo includi nella classe API.
/src/app.yaml Il descrittore di deployment dell'app web richiesto per la configurazione di App Engine.

I contenuti di ciascuno di questi file obbligatori sono documentati nelle sezioni seguenti.

Il file della classe API

I contenuti obbligatori e facoltativi del file (o dei file, se utilizzi un'API multi-classe) della classe sono descritti in dettaglio nell'argomento Creazione di un'API Endpoints.

Il file del server API

Questo file e i relativi contenuti sono descritti in dettaglio nella sezione Creazione di un server web.

app.yaml

I contenuti minimi richiesti per questo file sono i seguenti:

# 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

dove:

  • main è il nome del modulo e della variabile Python per il server API.
  • threadsafe è impostato su true se vuoi che App Engine invii più richieste in parallelo o su false se vuoi che le invii in serie.

Sono disponibili impostazioni aggiuntive, ma facoltative. Per saperne di più, consulta il riferimento app.yaml. Tuttavia, tieni presente che le informazioni riportate nelle sezioni Richiesta di accesso o stato di amministratore e URL sicuri non si applicano alle API di backend.