Limitaciones de las características de OpenAPI 2.0

En las siguientes secciones, se describen las limitaciones de las características de OpenAPI 2.0 en API Gateway.

Alcances ignorados

Aunque API Gateway acepta documentos de OpenAPI con alcances definidos en un objeto de esquema de seguridad, estos alcances no se verifican ni se aplican.

Varios requisitos de seguridad

  • Requisitos de la clave de API: API Gateway no admite requisitos de seguridad alternativos (OR lógico) si uno de los esquemas es una clave de API. Sin embargo, se admiten conjunciones (operador lógico AND), lo que te permite requerir tanto una clave de API como un token de OAuth2.
  • Requisitos de OAuth2: Se admiten requisitos de seguridad alternativos (operador lógico OR) para diferentes esquemas de seguridad de OAuth2.
  • No se admiten los requisitos de seguridad de conjunciones (operador lógico AND) para diferentes esquemas de seguridad de OAuth2.
  • Seguridad opcional: Se puede usar un requisito de seguridad vacío (- {}) para que la seguridad sea opcional para una clave de API, pero esto no es compatible con OAuth.

Validación de la definición de seguridad

API Gateway rechazará una especificación de OpenAPI 3.x que use un requisito de seguridad sin una definición correspondiente en la sección securityDefinitions.

Plantillas de ruta de URL

API Gateway solo admite parámetros de plantilla de ruta de URL que representan segmentos de ruta completos (p.ej., /items/{itemId}). No se admiten los parámetros que corresponden a segmentos parciales (como /items/prefix_{id}_suffix) y se rechazarán.

Parámetros, esquemas y tipos

API Gateway acepta documentos de OpenAPI con varias definiciones de parámetros y tipos (p.ej., parámetros required, formatos de array), pero no los aplica. Las solicitudes entrantes se reenvían a tu API independientemente de estas definiciones.

Referencias a tipos externos

API Gateway no admite referencias a tipos fuera del documento de OpenAPI proporcionado. Por ejemplo, no se permite un $ref que apunte a una URL externa y se rechazará.

Puerto personalizado en la dirección del host

API Gateway no permite puertos personalizados en el campo host de un documento de OpenAPI.

Limitaciones de los alias de YAML

Un documento de OpenAPI enviado a API Gateway puede tener un máximo de 200 nodos de alias de YAML.