Extensiones de OpenAPI 3.x en API Gateway
API Gateway acepta un conjunto de extensiones específicas de Google para la especificación de OpenAPI que configuran los comportamientos de la pasarela. Estas extensiones te permiten especificar ajustes de gestión de APIs, métodos de autenticación, límites de cuota e integraciones de backend directamente en tu documento OpenAPI. Conocer estas extensiones te ayudará a adaptar el comportamiento de tu servicio e integrarlo con las funciones de API Gateway.
En esta página se describen las extensiones específicas de Google de la especificación OpenAPI 3.x.
Aunque los ejemplos se muestran en formato YAML, también se admite JSON.
x-google-api-management
Obligatorio.
La extensión x-google-api-management define la configuración de gestión de APIs de nivel superior de tu servicio. Coloca esta extensión en la raíz de tu documento OpenAPI.
En la siguiente tabla se describen los campos de x-google-api-management:
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
metrics |
map[string]Metric |
No | Vacío | Defina métricas para aplicar límites de cuota. |
quota |
map[string]Quota |
No | Vacío | Especifica los límites de cuota de tu servicio. |
backends |
map[string]Backend |
Sí | Vacío | Configura los servicios de backend. |
apiName |
string |
No | Vacío | Asocia un nombre a las operaciones definidas en el documento de OpenAPI. |
Objeto Metric
El objeto Metric define una métrica que se usa para aplicar la cuota.
En la siguiente tabla se describen los campos de Metric:
| Campo | Tipo | Obligatorio | Predeterminado | Descripción |
|---|---|---|---|---|
displayName |
string |
No | Vacío | Nombre visible de la métrica. |
Objeto Quota
El objeto Quota define los límites de las cuotas.
En la siguiente tabla se describen los campos de