Definizione di server per una API

Le definizioni di server in un'API forniscono informazioni per la connessione ai server di destinazione.

Informazioni su questa attività

Nota:

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

È 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

  1. Apri l'API per la modifica, come descritto in Modifica di una definizione API OpenAPI 3.0.
  2. Espandi Generale quindi, se sono già definiti uno o più server, espandere Server.
  3. Per creare una nuova definizione di server, fare clic sull'icona Aggiungi OpenAPI 3.0 Icona di aggiunta API accanto a Server nel riquadro di navigazione. Per modificare una definizione di server esistente, fare clic sul server URL nel riquadro di navigazione.
  4. Immettere le seguenti informazioni:
    • Server URL (obbligatorio): Il server 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 l'API è pubblicata. 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 il server URL viene utilizzato per determinare l'endpoint completo URL, vedere Configurazione degli endpoint di vanità per un catalogo.
    • Descrizione del server : Una descrizione opzionale dell'host designato da URL. È possibile utilizzare la sintassi di CommonMark per una rappresentazione ricca di testo.
    • 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 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.
  5. Se si crea una nuova definizione server, fare clic su Crea.
    I dettagli di definizione del server vengono visualizzati per ulteriori modifiche come descritto nel passo 4.
  6. Fare clic su Salva una volta terminato.