Definizione di server per un percorso

Le definizioni del server per un percorso forniscono server di destinazione alternativi quando si richiama l'API in quel percorso.

Informazioni su questa attività

Nota:

Questa attività è correlata a una definizione API OpenAPI 3.0 . Per i dettagli su come configurare una definizione API OpenAPI 2.0 , vedi Modifica di una definizione API OpenAPI 2.0.
Le API OpenAPI 3.0 sono supportate solo con DataPower® API Gateway, non con DataPower Gateway (v5 compatible).
Per i dettagli sulle limitazioni correnti del supporto OpenAPI 3.0 , vedi OpenAPI 3.0 support in IBM® API Connect.

Puoi completare questa attività utilizzando l'applicazione IU API Designer o utilizzando l'IU API Manager basata sul browser.

Nota: è improbabile che tu debba definire i server per un percorso perché si applica solo se le operazioni API sono distribuite su endpoint gateway differenti e tale configurazione è possibile solo se stai ospitando le tue operazioni API sui tuoi propri endpoint di runtime al di fuori di API Connect. Per un'API pubblicata in DataPower API Gateway, tutte le operazioni API vengono richiamate sullo stesso servizio gateway.

Un server definito per un percorso sovrascrive qualsiasi server definito per l'API parent. È possibile definire più di un server, ma solo il primo viene utilizzato da API Connect.

In qualsiasi momento, puoi passare direttamente all'origine YAML OpenAPI sottostante facendo clic sull'icona Origine Icona origine OpenAPI . Per tornare al modulo di progettazione, fare clic su Modulo Icona modulo .

Procedura

Apri l'API per la modifica, come descritto in Modifica di una definizione API OpenAPI 3.0.
Espandere Percorsi
Espandere il percorso richiesto, quindi, se sono già definiti uno o più server per il percorso, espandere Server.
Per creare una nuova definizione server per il Percorso, fare clic sull'icona Aggiungi accanto a Server nel Percorso nel riquadro di navigazione. Per modificare una definizione di server esistente, fare clic sull' URL del server sotto il percorso nel riquadro di navigazione.
Immettere le seguenti informazioni:
- URL del server (obbligatorio): L' URL specificato viene utilizzato per determinare l'endpoint URL completo per la chiamata all'API, tenendo conto di qualsiasi configurazione di endpoint di vanità nel catalogo in cui è pubblicata l'API. Per un'API applicata da DataPower API Gateway, il valore immesso qui viene interpretato come il percorso di base in modo da fornire in genere solo il valore del percorso di base; ad esempio:
```
/my_basepath
```
  Per tutti i dettagli su come l' URL del server viene usato per determinare l'endpoint dell' URL completo, vedere Configurazione degli endpoint di vanità per un catalogo.
- Descrizione del server : Una descrizione opzionale dell'host designato dall' URL. È possibile utilizzare la sintassi di CommonMark per la rappresentazione di testo ricco.
- Variabili server (disponibile quando si modifica una definizione server esistente): una variabile server definisce una mappa tra un nome di variabile e il relativo valore. Il valore viene utilizzato per la sostituzione nel modello di URL del server.
  1. Per aggiungere una nuova variabile server, fare clic su Aggiungi. Per modificare una variabile server esistente, fare clic sul nome della variabile.
  2. Immettere le seguenti informazioni:
    - Nome variabile server (obbligatorio).
    - Valore Predefinito (obbligatorio).
    - Una descrizione rich text facoltativa. È possibile utilizzare la sintassi CommonMark per la rappresentazione rich text.
    - Una o più voci Valore Enum (disponibili quando si modifica una variabile server esistente). I valori di enumerazione specificano un'enumerazione di valori stringa da utilizzare se le opzioni di sostituzione provengono da una serie limitata. Per aggiungere un nuovo valore Enum, fare clic su Aggiungi, immettere il valore, quindi fare clic su Crea. Per modificare un valore Enum esistente, fare clic sul valore Enum.
  3. Se si sta creando una nuova variabile server, fare clic su Crea. I dettagli della variabile del server vengono visualizzati per ulteriori modifiche.
  4. Se necessario, utilizzare il percorso di navigazione per tornare alla definizione del server per ulteriori modifiche.
Se si crea una nuova definizione server, fare clic su Crea.
I dettagli del percorso vengono visualizzati per ulteriori modifiche come descritto in 5.
Fare clic su Salva una volta terminato.