Définissez la API basePath propriété Open

Dans Open API 2.0, vous pouvez utiliser la basePath propriété pour fournir une ou plusieurs parties de chemin qui précèdent chaque chemin défini dans la paths propriété. Comme API Gateway permet d'exprimer le chemin d'une ressource de plusieurs manières, la API fonction d'importation fournit les options suivantes pour interpréter la basePath propriété lors de l'importation : ignorer, ajouter au préalable et diviser.

Dans OpenAPI 3.0, basePath n'est plus une propriété de niveau supérieur. APIGateway utilise plutôt une variable de serveur comme convention. La API fonction d'importation fournit les mêmes options pour interpréter le chemin de base lors de l'importation. Le chemin de base est identifié comme suit :

• Si le API ne contient aucune basePath variable, la API fonction d'importation vérifie si la server.url chaîne contient un chemin au-delà"/". Si c'est le cas, ce chemin est utilisé comme chemin de base.

• S'il ne API contient qu'une seule basePath variable, la API fonction d'importation l'utilise comme chemin de base, même si elle n'est pas référencée dans leserver.url.

• S'il API contient plusieurs basePath variables, la API fonction d'importation utilise uniquement la première comme chemin de base.

Ignorer

Si le API fichier Open a une basePath valeur de /a/b/c et que la paths propriété contient /e et/f, ce qui suit POST ou PUT demande :

POST /restapis?mode=import&basepath=ignore

PUT /restapis/api_id?basepath=ignore

donne accès aux ressources suivantes dans le API :

• /

• /e

• /f

L'effet est de traiter le basePath comme s'il n'était pas présent, et toutes les API ressources déclarées sont servies par rapport à l'hôte. Cela peut être utilisé, par exemple, lorsque vous avez un nom de domaine personnalisé avec un API mappage qui n'inclut pas de chemin de base et une valeur d'étape qui fait référence à votre étape de production.

Note

APIGateway crée automatiquement une ressource racine pour vous, même si elle n'est pas explicitement déclarée dans votre fichier de définition.

Lorsqu'elle n'est pas spécifiée, la propriété basePath prend la valeur ignore par défaut.

Prepend

Si le fichier OpenAPI comporte une valeur basePath /a/b/c et si la propriété paths contient /e et /f, la demande POST ou PUT suivante :

POST /restapis?mode=import&basepath=prepend

PUT /restapis/api_id?basepath=prepend

donne accès aux ressources suivantes dans le API :

• /

• /a

• /a/b

• /a/b/c

• /a/b/c/e

• /a/b/c/f

Cela revient à traiter la propriété basePath comme des ressources supplémentaires de spécification (sans méthode) et à ajouter celles-ci à l'ensemble de ressources déclarées. Cela peut être utilisé, par exemple, lorsque différentes équipes sont responsables de différentes parties d'un API et basePath peuvent faire référence à l'emplacement du chemin pour chaque API partie d'une équipe.

Note

APIGateway crée automatiquement des ressources intermédiaires pour vous, même si elles ne sont pas explicitement déclarées dans votre définition.

Split

Si le fichier OpenAPI comporte une valeur basePath /a/b/c et si la propriété paths contient /e et /f, la demande POST ou PUT suivante :

POST /restapis?mode=import&basepath=split

PUT /restapis/api_id?basepath=split

donne accès aux ressources suivantes dans le API :

• /

• /b

• /b/c

• /b/c/e

• /b/c/f

Cela a pour effet de traiter la partie supérieure du chemin comme le début du chemin de chaque ressource et de créer des ressources supplémentaires (sans méthode) au sein de celle-ciAPI. /a Cela peut, par exemple, être a utilisé lorsque vous souhaitez exposer un nom de scène dans le cadre de votreAPI.