Limites des fonctionnalités OpenAPI 2.0
Les sections suivantes décrivent les limites des fonctionnalités OpenAPI 2.0 sur API Gateway.
Champs d'application ignorés
Bien qu'API Gateway accepte les documents OpenAPI avec des champs d'application définis dans un objet de schéma de sécurité, ces champs d'application ne sont pas vérifiés ni appliqués.
Exigences de sécurité multiples
- Exigences concernant les clés API : API Gateway n'est pas compatible avec les exigences de sécurité avec alternatives (opérateur logique "OU") si l'un des schémas est une clé API. Toutefois, les conjonctions (ET logique) sont acceptées, ce qui vous permet d'exiger à la fois une clé API et un jeton OAuth2.
- Exigences OAuth2 : les exigences de sécurité alternatives (opérateur logique "OU") sont acceptées pour différents schémas de sécurité OAuth2.
- Les exigences de sécurité avec conjonction (ET logique) pour différents schémas de sécurité OAuth2 ne sont pas acceptées.
- Sécurité facultative : une exigence de sécurité vide (
- {}) peut être utilisée pour rendre la sécurité facultative pour une clé API, mais cela n'est pas compatible avec OAuth.
Validation de la définition de la sécurité
API Gateway rejettera une spécification OpenAPI 3.x qui utilise une exigence de sécurité sans définition correspondante dans la section securityDefinitions.
Modèles de chemins d'URL
API Gateway n'accepte que les paramètres de modèles de chemin d'URL qui représentent des segments de chemin complets (par exemple, /items/{itemId}). Les paramètres correspondant à des segments partiels (tels que /items/prefix_{id}_suffix) ne sont pas acceptés et seront refusés.
Paramètres, schémas et types
API Gateway accepte les documents OpenAPI avec différentes définitions de paramètres et de types (par exemple, required, formats de tableaux), mais ne les applique pas. Les requêtes entrantes sont transmises à votre API, quelles que soient ces définitions.
Références à des types externes
API Gateway n'est pas compatible avec les références à des types situés en dehors du document OpenAPI fourni. Par exemple, un $ref pointant vers une URL externe n'est pas autorisé et sera refusé.
Port personnalisé dans l'adresse de l'hôte
API Gateway n'autorise pas les ports personnalisés dans le champ host d'un document OpenAPI.
Limites des alias YAML
Un document OpenAPI envoyé à API Gateway peut comporter jusqu'à 200 nœuds d'alias YAML.