Questa pagina è stata tradotta dall'API Cloud Translation.

Estensioni OpenAPI

OpenAPI | gRPC

Cloud Endpoints accetta un insieme di estensioni specifiche di Google per la specifica OpenAPI che configurano i comportamenti di Extensible Service Proxy (ESP), Extensible Service Proxy V2 (ESPv2) e Service Control. Questa pagina descrive le estensioni specifiche di Google alla specifica OpenAPI.

Sebbene gli esempi riportati di seguito siano in formato YAML, è supportato anche JSON.

Convenzione di denominazione

Le estensioni Google OpenAPI hanno nomi che iniziano con il prefisso x-google-.

`x-google-allow`

x-google-allow: [configured | all]

Questa estensione viene utilizzata al livello superiore di una specifica OpenAPI per indicare quali percorsi URL devono essere consentiti tramite ESP.

I valori possibili sono configured e all.

Il valore predefinito è configured, il che significa che solo i metodi API che hai elencato nella specifica OpenAPI vengono pubblicati tramite ESP.

Quando viene utilizzato all, le chiamate non configurate, con o senza una chiave API o autenticazione utente, passano attraverso ESP alla tua API.

ESP elabora le chiamate alla tua API in modo sensibile alle maiuscole e minuscole. Ad esempio, ESP considera /widgets e /Widgets come metodi API diversi.

Quando viene utilizzato all, devi prestare particolare attenzione a due aspetti:

Qualsiasi chiave API o regola di autenticazione.
Il routing del percorso di backend nel tuo servizio.

Come best practice, ti consigliamo di configurare l'API in modo che utilizzi il routing dei percorsi sensibile alle maiuscole e minuscole. Se utilizzi il routing sensibile alle maiuscole e minuscole, la tua API restituisce un codice di stato HTTP 404 quando il metodo richiesto nell'URL non corrisponde al nome del metodo API elencato nella specifica OpenAPI. Tieni presente che i framework di applicazioni web come Node.js Express hanno un'impostazione per attivare o disattivare il routing sensibile al maiuscolo/minuscolo. Il comportamento predefinito dipende dal framework che stai utilizzando. Ti consigliamo di rivedere le impostazioni nel framework per assicurarti che il routing sensibile alle maiuscole sia attivato. Questo consiglio è in linea con la specifica OpenAPI v2.0 che afferma: "Tutti i nomi dei campi nella specifica sono sensibili alle maiuscole e minuscole".

Esempio

Supponi che:

x-google-allow è impostato su all.
Il metodo API widgets è elencato nella specifica OpenAPI, ma non in Widgets.
Hai configurato la specifica OpenAPI in modo che richieda una chiave API.

Poiché widgets è elencato nella specifica OpenAPI, ESP blocca la seguente richiesta perché non ha una chiave API:

https://my-project-id.appspot.com/widgets

Poiché Widgets non è elencato nella specifica OpenAPI, ESP trasmette la seguente richiesta al tuo servizio senza una chiave API:

https://my-project-id.appspot.com/Widgets/

Se la tua API utilizza il routing sensibile alle maiuscole e minuscole (e non hai indirizzato le chiamate a "Widget" a nessun codice), il backend API restituisce un 404. Se, tuttavia, utilizzi il routing senza distinzione tra maiuscole e minuscole, il backend API instrada questa chiamata a "widgets".

Linguaggi e framework diversi hanno metodi diversi per controllare la distinzione tra maiuscole e minuscole e il routing. Per maggiori dettagli, consulta la documentazione del framework.

`x-google-backend`

L'estensione x-google-backend specifica come instradare le richieste ai backend locali o remoti. L'estensione può essere specificata a livello superiore e/o di operazione di una specifica OpenAPI.

Per impostazione predefinita, ESP è configurato per eseguire il proxy di tutto il traffico a un singolo backend locale. L'indirizzo del backend locale è specificato dal --backend flag (il valore predefinito è http://127.0.0.1:8081). Puoi utilizzare l'estensione x-google-backend per ignorare questo comportamento predefinito e specificare uno o più backend locali o remoti che possono ricevere richieste.

L'estensione x-google-backend può anche configurare altre impostazioni per i backend locali e remoti, come l'autenticazione e i timeout. Tutte queste configurazioni possono essere applicate in base all'operazione.

L'estensione x-google-backend contiene i seguenti campi:

`address`

address: URL

Facoltativo. L'URL del backend di destinazione. Lo schema dell'indirizzo deve essere http o https.

Quando il routing viene eseguito verso backend remoti (serverless), l'indirizzo deve essere impostato e la parte dello schema deve essere https.

Se un'operazione utilizza x-google-backend ma non specifica address, ESPv2 indirizzerà le richieste al backend locale specificato dal flag --backend.

`jwt_audience | disable_auth`

Deve essere impostata solo una di queste due proprietà.

Se un'operazione utilizza x-google-backend ma non specifica jwt_audience o disable_auth, ESPv2 imposterà automaticamente jwt_audience in modo che corrisponda a address. Se address non è impostato, ESPv2 imposterà automaticamente disable_auth su true.

`jwt_audience`

jwt_audience: string

Facoltativo. Il pubblico JWT specificato quando ESPv2 ottiene un token ID istanza, che viene poi utilizzato per effettuare la richiesta di backend di destinazione.

Quando configuri Endpoints per Serverless, il backend remoto deve essere protetto per consentire solo il traffico da ESPv2. ESPv2 collegherà un token ID istanza all'intestazione Authorization durante il proxy delle richieste. Il token ID istanza rappresenta il account di servizio di runtime utilizzato per il deployment di ESPv2. Il backend remoto può quindi verificare che la richiesta provenga da ESPv2 in base a questo token allegato.

Ad esempio, un backend remoto di cui è stato eseguito il deployment su Cloud Run può utilizzare IAM per:

Limita le chiamate non autenticate revocando roles/run.invoker dal principal speciale allUsers.
Consenti solo a ESPv2 di richiamare il backend concedendo il ruolo roles/run.invoker al account di servizio di runtime ESPv2.

Per impostazione predefinita, ESPv2 crea il token ID istanza con un pubblico JWT che corrisponde al campo address. La specifica manuale di jwt_audience è necessaria solo quando il backend di destinazione utilizza l'autenticazione basata su JWT e il pubblico previsto è diverso dal valore specificato nel campo address. Per i backend remoti di cui è stato eseguito il deployment su App Engine o con IAP, devi eseguire l'override del destinatario JWT. App Engine e IAP utilizzano il proprio ID client OAuth come pubblico previsto.

Quando questa funzionalità è attivata, ESPv2 modificherà le intestazioni nelle richieste. Se una richiesta ha già impostato l'intestazione Authorization, ESPv2:

Copia il valore originale in una nuova intestazione X-Forwarded-Authorization.
Esegui l'override dell'intestazione Authorization con il token ID istanza.

Pertanto, se un client API imposta l'intestazione Authorization, un backend in esecuzione dietro ESPv2 deve utilizzare l'intestazione X-Forwarded-Authorization per recuperare l'intero JWT. Il backend deve verificare il JWT in questa intestazione, poiché ESPv2 non esegue la verifica quando i metodi di autenticazione non sono configurati.

`disable_auth`

disable_auth: bool

Facoltativo. Questa proprietà determina se ESPv2 deve impedire l'ottenimento di un token ID istanza e impedirne l'allegato alla richiesta.

Quando configuri il backend di destinazione, potresti non voler utilizzare IAP o IAM per autenticare le richieste da ESPv2 se si verifica una delle seguenti condizioni:

Il backend deve consentire chiamate non autenticate.
Il backend richiede l'intestazione Authorization originale dal client API e non può utilizzare X-Forwarded-Authorization (descritto nella sezione jwt_audience).

In questo caso, imposta questo campo su true.

`path_translation`

path_translation: [ APPEND_PATH_TO_ADDRESS | CONSTANT_ADDRESS ]

Facoltativo. Imposta la strategia di conversione del percorso utilizzata da ESPv2 quando proxy le richieste al backend di destinazione.

Per ulteriori dettagli sulla traduzione dei percorsi, consulta la sezione Informazioni sulla traduzione dei percorsi.

Quando x-google-backend viene utilizzato al livello superiore della specifica OpenAPI, path_translation viene impostato per impostazione predefinita su APPEND_PATH_TO_ADDRESS e quando x-google-backend viene utilizzato a livello di operazione della specifica OpenAPI, path_translation viene impostato per impostazione predefinita su CONSTANT_ADDRESS. Se il campo address non è presente, path_translation rimarrà non specificato e non si verificherà.

`deadline`

deadline: double

Facoltativo. Il numero di secondi di attesa per una risposta completa a una richiesta. Le risposte che richiedono più tempo rispetto alla scadenza configurata andranno in timeout. La scadenza predefinita è di 15.0 secondi.

I valori non positivi non verranno accettati. ESPv2 utilizzerà automaticamente il valore predefinito in questi casi.

Il limite di tempo non può essere disattivato, ma può essere impostato su un numero elevato, ad esempio 3600.0 per un'ora.

`protocol`

protocol: [ http/1.1 | h2 ]

Facoltativo. Il protocollo utilizzato per l'invio di una richiesta al backend. I valori supportati sono http/1.1 e h2.

Il valore predefinito è http/1.1 per i backend HTTP e HTTPS.

Per i backend HTTP sicuri (https://) che supportano HTTP/2, imposta questo campo su h2 per migliorare le prestazioni. Questa è l'opzione consigliata per Google Cloud i backend serverless.

Abilitazione del supporto dei backend in ESP

ESPv2 rileverà automaticamente quando è configurato x-google-backend.

Per attivare questa funzionalità, ESP richiede una modifica manuale della configurazione. Attiva il supporto di x-google-backend in ESP fornendo l'argomento --enable_backend_routing durante l'esecuzione del container ESP. Per i runtime in cui non controlli le opzioni del contenitore ESP, questa opzione è già fornita. Di seguito è riportato un esempio di attivazione del supporto di x-google-backend durante il deployment del container ESP su GKE (questo esempio si basa sull'esempio del tutorial su Endpoints su GKE):

- name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:1
  args: [
    "--http_port", "8081",
    "--service", "SERVICE_NAME",
    "--rollout_strategy", "managed",
    "--enable_backend_routing"
  ]

Informazioni sulla traduzione dei percorsi

Quando ESP gestisce le richieste, prende il percorso della richiesta originale e lo traduce prima di effettuare una richiesta al backend di destinazione. Il modo esatto in cui avviene questa traduzione dipende dalla strategia di traduzione del percorso che stai utilizzando. Esistono due strategie di traduzione dei percorsi:

APPEND_PATH_TO_ADDRESS: Il percorso della richiesta di backend di destinazione viene calcolato aggiungendo il percorso della richiesta originale all'URL address dell'estensione x-google-backend.
CONSTANT_ADDRESS: il percorso della richiesta di destinazione è costante, come definito dall'URL address dell'estensione x-google-backend. Se il percorso OpenAPI corrispondente contiene parametri, il nome del parametro e il relativo valore diventanoparametri di ricercary.

Esempi:

APPEND_PATH_TO_ADDRESS
- address: https://my-project-id.appspot.com/BASE_PATH
- Con i parametri di percorso OpenAPI
  - Percorso OpenAPI: /hello/{name}
  - Percorso della richiesta: /hello/world
  - URL di richiesta di destinazione: https://my-project-id.appspot.com/BASE_PATH/hello/world
- Senza parametri di percorso OpenAPI
  - Percorso OpenAPI: /hello
  - Percorso della richiesta: /hello
  - URL di richiesta di destinazione: https://my-project-id.appspot.com/BASE_PATH/hello
CONSTANT_ADDRESS
- address: https://us-central1-my-project-id.cloudfunctions.net/helloGET
- Con i parametri di percorso OpenAPI
  - Percorso OpenAPI: /hello/{name}
  - Percorso della richiesta: /hello/world
  - URL di richiesta di destinazione: https://us-central1-my-project-id.cloudfunctions.net/helloGET?name=world
- Senza parametri di percorso OpenAPI
  - Percorso OpenAPI: /hello
  - Percorso della richiesta: /hello
  - URL di richiesta di destinazione: https://us-central1-my-project-id.cloudfunctions.net/helloGET

`x-google-endpoints`

Questa sezione descrive gli utilizzi dell'estensione x-google-endpoints.

Configurazione del DNS sul dominio `cloud.goog`

Se hai eseguito il deployment della tua applicazione su Compute Engine o Google Kubernetes Engine, puoi creare una voce DNS per il tuo servizio Endpoints sul dominio cloud.goog aggiungendo quanto segue al tuo documento OpenAPI:

x-google-endpoints:
- name: "API_NAME.endpoints.PROJECT_ID.cloud.goog"
  target: "IP_ADDRESS"

Aggiungi l'estensione x-google-endpoints al livello superiore del documento OpenAPI (non rientrata o nidificata). Devi configurare il nome di dominio nel formato: .endpoints.PROJECT_ID.cloud.goog

Ad esempio:

swagger: "2.0"
host: "my-cool-api.endpoints.my-project-id.cloud.goog"
x-google-endpoints:
- name: "my-cool-api.endpoints.my-project-id.cloud.goog"
  target: "192.0.2.1"

Il dominio .cloud.goog è gestito da Google e condiviso da Google Cloud clienti. Poiché gli ID progetto sono univoci a livello globale, un nome di dominio nel formato .endpoints.PROJECT_ID.cloud.goog è un nome di dominio univoco per la tua API. Google Cloud

Per semplicità, configura il campo host e il campo x-google-endpoints.name in modo che siano uguali. Quando esegui il deployment del documento OpenAPI, Service Management crea:

Un servizio gestito con il nome specificato nel campo host.
Un record A DNS che utilizza il nome e l'indirizzo IP configurati nell'estensione x-google-endpoints.

Per le API ospitate nell'ambiente flessibile di App Engine, puoi utilizzare il dominio appspot.com. Per ulteriori informazioni, consulta la sezione Configurazione degli endpoint.

Configurazione di ESP per consentire le richieste CORS

Se la tua API viene chiamata da un'applicazione web su un'origine diversa, deve supportare la condivisione delle risorse tra origini (CORS). Consulta Aggiunta del supporto CORS a ESP per informazioni sulla configurazione di ESP per supportare CORS.

Se devi implementare il supporto CORS personalizzato nel codice backend, imposta allowCors: True in modo che ESP trasmetta tutte le richieste CORS al codice backend:

x-google-endpoints:
- name: "API_NAME.endpoints.PROJECT_ID.cloud.goog"
  allowCors: True

Aggiungi l'estensione x-google-endpoints al livello superiore del documento OpenAPI (non rientrato o nidificato), ad esempio:

swagger: "2.0"
host: "my-cool-api.endpoints.my-project-id.cloud.goog"
x-google-endpoints:
- name: "my-cool-api.endpoints.my-project-id.cloud.goog"
  allowCors: True

`x-google-issuer`

x-google-issuer: URI | EMAIL_ADDRESS

Questa estensione viene utilizzata nella sezione securityDefinitions di OpenAPI per specificare l'emittente di una credenziale. I valori possono assumere la forma di un nome host o di un indirizzo email.

`x-google-jwks_uri`

x-google-jwks_uri: URI

URI del set di chiavi pubbliche del fornitore impostato per convalidare la firma del token JWT (JSON Web Token).

ESP supporta due formati di chiave pubblica asimmetrica definiti dall'estensione OpenAPI x-google-jwks_uri:

Formato del set JWK. Ad esempio:

x-google-jwks_uri: "https://YOUR_ACCOUNT_NAME.YOUR_AUTH_PROVIDER_URL/.well-known/jwks.json"

X509. Ad esempio:

x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/metadata/x509/securetoken@system.gserviceaccount.com"

Se utilizzi un formato di chiave simmetrica, imposta x-google-jwks_uri sull'URI di un file che contiene la stringa della chiave codificata in base64url.

Se ometti x-google-jwks_uri, ESP seguirà il protocollo OpenID Connect Discovery per rilevare automaticamente l'URI JWKS per il provider OpenID specificato. ESP invierà una richiesta a x-google-issuer/.well-known/openid-configuration, analizzerà la risposta JSON e leggerà l'URI JWKS dal campo jwks_uri di primo livello.

Tieni presente che l'omissione di x-google-jwks_uri comporterà tempi di avvio a freddo più lunghi, in quanto ESP deve effettuare una chiamata remota aggiuntiva all'avvio. Pertanto, è consigliabile omettere questo campo solo se l'URI JWKS cambia spesso. La maggior parte dei provider OpenID certificati (come Google, Auth0 e Okta) ha URI JWKS stabili.

`x-google-jwt-locations`

Per impostazione predefinita, un JWT viene passato nell'intestazione Authorization (con prefisso "Bearer "), nell'intestazione X-Goog-Iap-Jwt-Assertion o nel parametro di query access_token. Per esempi di passaggio di un JWT, vedi Effettuare una chiamata autenticata a un'API Endpoints.

In alternativa, utilizza l'estensione x-google-jwt-locations nella sezione securityDefinitions di OpenAPI per fornire le posizioni personalizzate da cui estrarre il token JWT.

L'estensione x-google-jwt-locations accetta un elenco di posizioni JWT. Ogni posizione JWT contiene i seguenti campi:

Elemento	Descrizione
`header/query`	Obbligatorio. Il nome dell'intestazione contenente il JWT o il nome del parametro di query contenente il JWT.
`value_prefix`	Facoltativo. Solo per l'intestazione. Quando `value_prefix` è impostato, il suo valore deve corrispondere al prefisso del valore dell'intestazione contenente il JWT.

Ad esempio:

x-google-jwt-locations:
  # Expect header "Authorization": "MyBearerToken <TOKEN>"
  - header: "Authorization"
    value_prefix: "MyBearerToken "
  # expect header "jwt-header-foo": "jwt-prefix-foo<TOKEN>"
  - header: "jwt-header-foo"
    value_prefix: "jwt-prefix-foo"
  # expect header "jwt-header-bar": "<TOKEN>"
  - header: "jwt-header-bar"
  # expect query parameter "jwt_query_bar=<TOKEN>"
  - query: "jwt_query_bar"

Se vuoi supportare solo un sottoinsieme delle posizioni JWT predefinite, elencale esplicitamente nell'estensione x-google-jwt-locations. Ad esempio, per includere il supporto solo per l'intestazione Authorization con il prefisso "Bearer ":

  x-google-jwt-locations:
    # Support the default header "Authorization": "Bearer <TOKEN>"
    - header: "Authorization"
      value_prefix: "Bearer "

`x-google-audiences`

x-google-audiences: STRING

Questa estensione viene utilizzata nella sezione securityDefinitions di OpenAPI per fornire un elenco di segmenti di pubblico a cui deve corrispondere il campo JWT aud durante l'autenticazione JWT. Questa estensione accetta una singola stringa con valori separati da una virgola. Gli spazi non sono consentiti tra i segmenti di pubblico. Se non è specificato, il campo JWT aud deve corrispondere al campo host nel documento OpenAPI, a meno che non venga utilizzato il flag --disable_jwt_audience_service_name_check. Se il flag viene utilizzato e x-google-audiences non è specificato, il campo JWT aud non viene selezionato.

securityDefinitions:
  google_id_token:
    type: oauth2
    authorizationUrl: ""
    flow: implicit
    x-google-issuer: "https://accounts.google.com"
    x-google-jwks_uri: "https://www.googleapis.com/oauth2/v1/certs"
    x-google-audiences: "848149964201.apps.googleusercontent.com,841077041629.apps.googleusercontent.com"

`x-google-management`

L'estensione x-google-management controlla diversi aspetti della gestione delle API e contiene i campi descritti in questa sezione.

`metrics`

Utilizzi metrics insieme a quota e x-google-quota per configurare una quota per la tua API. Una quota ti consente di controllare la frequenza con cui le applicazioni possono chiamare i metodi nella tua API. Ad esempio:

x-google-management:
  metrics:
    - name: read-requests
      displayName: Read requests
      valueType: INT64
      metricKind: DELTA

Il campo metrics contiene un elenco con le seguenti coppie chiave-valore:

Elemento	Descrizione
nome	Obbligatorio. Il nome di questa metrica. In genere, questo è il tipo di richiesta (ad esempio "read-requests" o "write-requests") che identifica in modo univoco la metrica.
displayName	Facoltativo, ma consigliato. Il testo visualizzato per identificare la metrica nella scheda Quote della pagina Endpoints > Servizi nella consoleGoogle Cloud . Questo testo viene visualizzato anche dai consumer della tua API nelle pagine Quote nelle sezioni IAM e amministrazione e API e servizi. Il nome visualizzato deve contenere un massimo di 40 caratteri. Per motivi di leggibilità, l'unità del limite della quota associata viene aggiunta automaticamente al nome visualizzato nella consoleGoogle Cloud . Ad esempio, se specifichi "Richieste di lettura" per il nome visualizzato, nella consoleGoogle Cloud viene visualizzato "Richieste di lettura al minuto per progetto". Se non specificata, la "quota senza etichetta" viene visualizzata ai consumer della tua API nelle pagine Quote in IAM e amministrazione e API e servizi. Per mantenere la coerenza con i nomi visualizzati dei servizi Google elencati nella pagina Quote che vedono i consumatori della tua API, ti consigliamo quanto segue per il nome visualizzato: Utilizza "Richieste" quando hai una sola metrica. Quando hai più metriche, ognuna deve descrivere il tipo di richiesta e contenere la parola "richieste" (ad esempio "Richieste di lettura" o "Richieste di scrittura"). Utilizza "unità di quota" anziché "richieste" quando uno dei costi associati alla metrica è superiore a 1.
valueType	Obbligatorio. Deve essere INT64
metricKind	Obbligatorio. Deve essere DELTA

`quota`

Specifica il limite della quota per una metrica definita nella sezione quota. Ad esempio:

quota:
  limits:
    - name: read-requests-limit
      metric: read-requests
      unit: 1/min/{project}
      values:
        STANDARD: 5000

Il campo quota.limits contiene un elenco con le seguenti coppie chiave-valore:

Elemento	Descrizione
nome	Obbligatorio. Nome del limite, che deve essere univoco all'interno del servizio. Il nome può contenere lettere maiuscole e minuscole, numeri e "-" (il carattere trattino) e deve avere una lunghezza massima di 64 caratteri.
metrica	Obbligatorio. Il nome della metrica a cui si applica questo limite. Questo nome deve corrispondere al testo specificato nel nome di una metrica. Se il testo specificato non corrisponde a un nome di metrica, viene visualizzato un errore quando implementi il documento OpenAPI.
unità	Obbligatorio. L'unità del limite. Attualmente è supportato solo "1/min/{project}", il che significa che il limite viene applicato per progetto e l'utilizzo viene reimpostato ogni minuto.
valori	Obbligatorio. Il limite per la metrica. Devi specificarlo come coppia chiave-valore nel seguente formato: STANDARD: `YOUR-LIMIT-FOR-THE-METRIC` Sostituisci `YOUR-LIMIT-FOR-THE-METRIC` con un valore intero che corrisponde al numero massimo di richieste consentite per l'unità specificata (attualmente solo al minuto, per progetto). Ad esempio: values: STANDARD: 5000

`x-google-quota`

L'estensione x-google-quota viene utilizzata nella sezione OpenAPI paths per associare un metodo nella tua API a una metrica. I metodi per cui non è definito x-google-quota non hanno limiti di quota applicati. Ad esempio:

x-google-quota:
  metricCosts:
    read-requests: 1

L'estensione x-google-quota contiene il seguente elemento:

Elemento Descrizione

metricCosts

Elemento	Descrizione
metricCosts	Una coppia chiave:valore definita dall'utente: `"YOUR-METRIC-NAME": METRIC-COST`. `"YOUR-METRIC-NAME":` Il testo per `"YOUR-METRIC-NAME"` deve corrispondere a un nome di metrica definito. `METRIC-COST:` Un valore intero che definisce il costo per ogni richiesta. Quando viene effettuata una richiesta, la metrica associata viene incrementata del costo specificato. Il costo consente ai metodi di utilizzare la stessa metrica a velocità diverse. Ad esempio, se una metrica ha un limite di quota di 1000 e un costo di 1, l'applicazione chiamante può effettuare 1000 richieste al minuto prima di superare il limite. Con un costo di 2 per la stessa metrica, un'applicazione di chiamata può effettuare solo 500 richieste al minuto prima di superare il limite.

Una coppia chiave:valore definita dall'utente: "YOUR-METRIC-NAME": METRIC-COST.

"YOUR-METRIC-NAME": Il testo per "YOUR-METRIC-NAME" deve corrispondere a un nome di metrica definito.
METRIC-COST: Un valore intero che definisce il costo per ogni richiesta. Quando viene effettuata una richiesta, la metrica associata viene incrementata del costo specificato. Il costo consente ai metodi di utilizzare la stessa metrica a velocità diverse. Ad esempio, se una metrica ha un limite di quota di 1000 e un costo di 1, l'applicazione chiamante può effettuare 1000 richieste al minuto prima di superare il limite. Con un costo di 2 per la stessa metrica, un'applicazione di chiamata può effettuare solo 500 richieste al minuto prima di superare il limite.

Esempi di quote

L'esempio seguente mostra l'aggiunta di una metrica e di un limite per le richieste di lettura e scrittura.

x-google-management:
  metrics:
    # Define a metric for read requests.
    - name: "read-requests"
      displayName: "Read requests"
      valueType: INT64
      metricKind: DELTA
    # Define a metric for write requests.
    - name: "write-requests"
      displayName: "Write requests"
      valueType: INT64
      metricKind: DELTA
  quota:
    limits:
      # Rate limit for read requests.
      - name: "read-requests-limit"
        metric: "read-requests"
        unit: "1/min/{project}"
        values:
          STANDARD: 5000
      # Rate limit for write requests.
      - name: "write-request-limit"
        metric: "write-requests"
        unit: "1/min/{project}"
        values:
          STANDARD: 5000

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"
      x-google-quota:
        metricCosts:
          read-requests: 1
      security:
      - api_key: []

`x-google-api-name`

Quando il servizio contiene una sola API, il nome dell'API è uguale al nome del servizio Endpoints. Endpoints utilizza il nome che specifichi nel campo host del documento OpenAPI come nome del servizio. Se il tuo servizio contiene più di un'API, specifica i nomi delle API aggiungendo l'estensione x-google-api-name al documento OpenAPI. L'estensione x-google-api-name consente di denominare esplicitamente le singole API e stabilire un controllo delle versioni indipendente per ciascuna API.

Ad esempio, puoi configurare un servizio denominato api.example.com con due API, producer e consumer, con i frammenti di documento OpenAPI riportati di seguito:

API Producer in producer.yaml:

swagger: 2.0
host: api.example.com
x-google-api-name: producer
info:
  version: 1.0.3

API consumer in consumer.yaml:

swagger: 2.0
host: api.example.com
x-google-api-name: consumer
info:
  version: 1.1.0

Puoi eseguire il deployment dei due documenti OpenAPI con:

gcloud endpoints services deploy producer.yaml consumer.yaml

Estensioni OpenAPI Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Convenzione di denominazione

x-google-allow

Esempio

x-google-backend

address

jwt_audience | disable_auth

jwt_audience

disable_auth

path_translation

deadline

protocol

Abilitazione del supporto dei backend in ESP

Informazioni sulla traduzione dei percorsi

x-google-endpoints

Configurazione del DNS sul dominio cloud.goog