Limitações das funcionalidades da OpenAPI 2.0

As secções seguintes descrevem as limitações das funcionalidades do OpenAPI 2.0 no API Gateway.

Âmbitos ignorados

Embora o API Gateway aceite documentos OpenAPI com âmbitos definidos num objeto de esquema de segurança, estes âmbitos não são verificados nem aplicados.

Vários requisitos de segurança

  • Requisitos da chave da API: o API Gateway não suporta requisitos de segurança alternativos (OR lógico) se um dos esquemas for uma chave da API. No entanto, as conjunções (AND lógico) são suportadas, o que lhe permite exigir uma chave de API e um token OAuth2.
  • Requisitos do OAuth2: os requisitos de segurança alternativos (OR lógico) são suportados para diferentes esquemas de segurança do OAuth2.
  • Os requisitos de segurança de conjunções (AND lógico) para diferentes esquemas de segurança OAuth2 não são suportados.
  • Segurança opcional: pode usar um requisito de segurança vazio (- {}) para tornar a segurança opcional para uma chave de API, mas isto não é suportado para o OAuth.

Validação da definição de segurança

O API Gateway rejeita uma especificação OpenAPI 3.x que use um requisito de segurança sem uma definição correspondente na secção securityDefinitions.

Criação de modelos de caminhos de URLs

O API Gateway só suporta parâmetros de modelo de caminho de URL que representam segmentos de caminho completos (por exemplo, /items/{itemId}). Os parâmetros correspondentes a segmentos parciais (como /items/prefix_{id}_suffix) não são suportados e serão rejeitados.

Parâmetros, esquemas e tipos

O API Gateway aceita documentos OpenAPI com várias definições de parâmetros e tipos (por exemplo, required, formatos de matriz), mas não os aplica. Os pedidos recebidos são encaminhados para a sua API, independentemente destas definições.

Referências de tipo externo

O API Gateway não suporta referências a tipos fora do documento OpenAPI facultado. Por exemplo, um $ref que aponte para um URL externo não é permitido e será rejeitado.

Porta personalizada no endereço do anfitrião

O API Gateway não permite portas personalizadas no campo host de um documento OpenAPI.

Limitações dos nomes alternativos YAML

Um documento OpenAPI enviado para o API Gateway pode ter um máximo de 200 nós de alias YAML.