Un percorso è un'unità di un'API REST che è possibile richiamare. Un Path (percorso) è composto da un verbo " HTTP " (andare) e da un " URL " (percorso). Configurando il percorso, si definisce come viene esposta l'API agli sviluppatori.
Informazioni su questa attività
Puoi completare questa attività utilizzando l'applicazione IU API Designer o utilizzando l'IU API Manager basata sul browser.
Il percorso è allegato al server URL per formare il sito completo URL. Per ulteriori informazioni sulla configurazione dei server, consultare la sezione Definizione dei server per un'API.
In qualsiasi momento puoi passare direttamente al codice sorgente YAML sottostante dell' OpenAPI, cliccando 
sull'icona "Sorgente". Per tornare al modulo di progettazione, clicca sull'icona 
Modulo.
Procedura
- Apri l'API per la modifica, come descritto in Modifica di una definizione API OpenAPI 3.0.
- Se sono già definiti uno o più percorsi, espandere Percorsi.
- Per creare un nuovo percorso, clicca sull'icona "Aggiungi" accanto
alla voce "Percorsi" nel pannello di navigazione. Per modificare un percorso esistente, fare clic sul percorso nel riquadro di navigazione. - Fornisci le seguenti informazioni:
- Percorso: un percorso relativo a un singolo endpoint.
Il percorso viene aggiunto al percorso di base per formare l'URI completo necessario per accedere alle API. Il percorso deve iniziare, ma non terminare, con il carattere /. Un parametro alla fine del percorso può contenere un qualificatore che corrisponde a uno o più livelli di percorso.
Se si specifica solo il nome del parametro, viene messo in corrispondenza un livello di tale percorso. Se si desidera consentire più livelli del percorso, è possibile aggiungere al parametro uno dei seguenti qualificatori:
- * per indicare 0 o più ricorrenze
- + per indicare 1 o più ricorrenze
I qualificatori + e * possono essere utilizzati solo alla fine del percorso.
Ad esempio, il percorso:
/petstore/{type}/{*category}
corrisponde ai seguenti percorsi, in cui viene trovato un solo valore di tipo, ma vengono messe in corrispondenza tutte le categorie (0 o più):
/petstore/cats
/petstore/cats/supplies
/petstore/cats/supplies/health
/petstore/cats/supplies/health/medicines
/petstore/cats/supplies/health/medicines/a/b/c
- Rif (disponibile quando si modifica un percorso esistente): un riferimento ad un percorso definito altrove, in questa definizione OpenAPI o in un file esterno. Un riferimento abilita il riuso di una serie di operazioni già definite per un percorso in questa API o in un file che è una definizione API completa o un frammento OpenAPI .
Il riferimento utilizza la notazione del puntatore JSON. Ad esempio, un riferimento a un percorso denominato
/mypath in questa API avrà il seguente formato:
#/paths/~1mypath
I caratteri
~1 vengono utilizzati per eseguire l'escape del carattere
/ , che viene utilizzato letteralmente nel nome del percorso piuttosto che come un carattere speciale.
Un riferimento a un percorso in un file esterno denominato
path_fragments.yaml ha il seguente formato:
file://path_fragments.yaml/paths/~1mypath
- Riepilogo: un riepilogo facoltativo, da applicare a tutte le operazioni in questo percorso.
- Descrizione: una descrizione facoltativa, da applicare a tutte le operazioni in questo percorso. È possibile utilizzare la sintassi CommonMark per la rappresentazione in formato RTF.
- Se si crea un nuovo percorso, fare clic su Crea.
I dettagli del percorso vengono visualizzati per un'ulteriore modifica, come descritto nel passo
4.
- Fare clic su Salva una volta terminato.