Impostare la proprietà Open API basePath

In Open API 2.0, è possibile utilizzare la basePath proprietà per fornire una o più parti del percorso che precedono ogni percorso definito nella paths proprietà. Poiché API Gateway offre diversi modi per esprimere il percorso di una risorsa, la API funzione Importa fornisce le seguenti opzioni per interpretare la basePath proprietà durante l'importazione: ignora, anteponi e dividi.

In OpenAPI 3.0 basePath non è più una proprietà di primo livello. APIGateway utilizza invece una variabile server come convenzione. La API funzione di importazione offre le stesse opzioni per interpretare il percorso di base durante l'importazione. Il percorso di base può essere identificato in questo modo:

• Se API non contiene alcuna basePath variabile, la API funzione di importazione controlla la server.url stringa per vedere se contiene un percorso successivo. "/" Se sì, il percorso viene usato come percorso di base.

• Se API contiene una sola basePath variabile, la API funzione di importazione la utilizza come percorso di base, anche se non è referenziata server.url in.

• Se API contiene più basePath variabili, la API funzione di importazione utilizza solo la prima come percorso di base.

Ignorare

Se il API file Apri ha un basePath valore di /a/b/c e la paths proprietà contiene /e e/f, quanto segue POST o PUT richiede:

POST /restapis?mode=import&basepath=ignore

PUT /restapis/api_id?basepath=ignore

produce le seguenti risorse inAPI:

• /

• /e

• /f

L'effetto è quello di trattarlo basePath come se non fosse presente e tutte le API risorse dichiarate vengono servite rispetto all'host. Questo può essere utilizzato, ad esempio, quando si dispone di un nome di dominio personalizzato con una API mappatura che non include un Base Path e un valore Stage che si riferisce alla fase di produzione.

Nota

APIGateway crea automaticamente una risorsa root per voi, anche se non è dichiarata esplicitamente nel file di definizione.

In assenza di specifiche, basePath seleziona ignore per impostazione predefinita.

Metti come prefisso

Se nel file OpenAPI il valore di basePath è /a/b/c e la proprietà paths contiene /e e /f, la richiesta POST o PUT seguente:

POST /restapis?mode=import&basepath=prepend

PUT /restapis/api_id?basepath=prepend

produce le seguenti risorse in: API

• /

• /a

• /a/b

• /a/b/c

• /a/b/c/e

• /a/b/c/f

L'effetto è trattare il basePath come se specificasse risorse aggiuntive (senza metodo) e aggiungerle al set di risorse dichiarato. Questo può essere utilizzato, ad esempio, quando team diversi sono responsabili di diverse parti di un team API e basePath possono fare riferimento alla posizione del percorso per ogni API parte del team.

Nota

APIGateway crea automaticamente risorse intermedie per te, anche se non sono dichiarate esplicitamente nella tua definizione.

Split

Se nel file OpenAPI il valore di basePath è /a/b/c e la proprietà paths contiene /e e /f, la richiesta POST o PUT seguente:

POST /restapis?mode=import&basepath=split

PUT /restapis/api_id?basepath=split

si traduce nelle seguenti risorse in: API

• /

• /b

• /b/c

• /b/c/e

• /b/c/f

L'effetto è quello di considerare la parte più in alto del percorso come l'inizio del percorso di ogni risorsa e di creare risorse aggiuntive (senza metodo) all'interno del percorso API stesso. /a Questo potrebbe, ad esempio, essere usato quando a è un nome d'arte che vuoi esporre come parte del tuo. API