Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Legen Sie die API basePath Eigenschaft Öffnen fest
In Open API 2.0basePath Eigenschaft verwenden, um einen oder mehrere Pfadteile bereitzustellen, die jedem in der paths Eigenschaft definierten Pfad vorangehen. Da API Gateway über mehrere Möglichkeiten verfügt, den Pfad einer Ressource auszudrücken, bietet die API Importfunktion die folgenden Optionen für die Interpretation der basePath Eigenschaft beim Import: Ignorieren, Voranstellen und Teilen.
In OpenAPI 3.0basePath keine Top-Level-Eigenschaft mehr. Stattdessen verwendet API Gateway eine Servervariable
-
Wenn der API keine
basePathVariablen enthält, überprüft die API Importfunktion dieserver.urlZeichenfolge, um festzustellen, ob sie einen darüberliegenden Pfad enthält"/". Wenn dies der Fall ist, wird dieser Pfad als Basispfad verwendet. -
Wenn der nur eine
basePathVariable API enthält, verwendet die API Importfunktion ihn als Basispfad, auch wenn in der nicht darauf verwiesen wirdserver.url. -
Wenn der mehrere
basePathVariablen API enthält, verwendet die API Importfunktion nur die erste als Basispfad.
Ignore
Wenn die API Datei Öffnen den basePath Wert hat /a/b/c und die paths Eigenschaft /e und enthält/f, ist Folgendes POST oder eine PUT Anforderung erforderlich:
POST /restapis?mode=import&basepath=ignore
PUT /restapis/api_id?basepath=ignore
führt zu den folgenden Ressourcen in derAPI:
-
/ -
/e -
/f
Der Effekt besteht darin, dass der basePath so behandelt wird, als ob er nicht vorhanden wäre, und alle deklarierten API Ressourcen werden relativ zum Host bereitgestellt. Dies kann beispielsweise verwendet werden, wenn Sie einen benutzerdefinierten Domainnamen mit einer API Zuordnung haben, die keinen Basispfad und keinen Stage-Wert enthält, der sich auf Ihre Produktionsphase bezieht.
Anmerkung
APIGateway erstellt automatisch eine Root-Ressource für Sie, auch wenn sie nicht explizit in Ihrer Definitionsdatei deklariert ist.
Wenn nicht angegeben, wird basePath standardmäßig auf ignore gesetzt.
Voranstellen
Wenn in der OpenAPI-Datei der Wert der basePath-Eigenschaft lautet und die /a/b/c-Eigenschaft pathsund/e enthält, führt die folgende /fPOST- oder POSTPUTPUT-Anforderung:
POST /restapis?mode=import&basepath=prepend
PUT /restapis/api_id?basepath=prepend
führt zu den folgenden Ressourcen in derAPI:
-
/ -
/a -
/a/b -
/a/b/c -
/a/b/c/e -
/a/b/c/f
Dadurch wird die Eigenschaft basePath so behandelt, als würde sie zusätzliche Ressourcen (ohne Methoden) angeben und diese zum deklarierten Ressourcensatz hinzufügen. Dies kann beispielsweise verwendet werden, wenn verschiedene Teams für verschiedene Teile eines Teams verantwortlich sind API und die Pfadposition für den API Teil jedes Teams referenzieren basePath könnte.
Anmerkung
APIGateway erstellt automatisch Zwischenressourcen für Sie, auch wenn sie in Ihrer Definition nicht explizit deklariert sind.
Teilen
Wenn in der OpenAPI-Datei der Wert der basePath-Eigenschaft lautet und die /a/b/c-Eigenschaft pathsund/e enthält, führt die folgende /fPOST- oder POSTPUTPUT-Anforderung:
POST /restapis?mode=import&basepath=split
PUT /restapis/api_id?basepath=split
führt zu den folgenden Ressourcen in derAPI:
-
/ -
/b -
/b/c -
/b/c/e -
/b/c/f
Der Effekt besteht darin/a, den obersten Teil des Pfads als Anfang des Pfads jeder Ressource zu behandeln und zusätzliche Ressourcen (keine Methode) innerhalb des Pfads API selbst zu erstellen. Dies könnte beispielsweise verwendet werden, wenn a es sich um einen Phasennamen handelt, den Sie als Teil Ihres API verfügbar machen möchten.
