Modifica di un parametro

I parametri definiscono gli elementi variabili di un percorso di trasferimento dei dati ( URL ), i parametri di query, le intestazioni o il corpo di una richiesta. Puoi modificare i parametri che sono stati precedentemente creati per l'API o per le operazioni Percorsi e Percorsi nella tua definizione API.

Prima di iniziare

Aprire il modulo dei dettagli per un parametro. Per i dettagli delle aree nella tua definizione API da cui puoi modificare un parametro, consulta i seguenti argomenti:

Informazioni su questa attività

Nota: questa attività fa riferimento alla configurazione di una definizione API OpenAPI 2.0 . Per i dettagli su come configurare una definizione API OpenAPI 3.0 , vedi Modifica di una definizione API OpenAPI 3.0.

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

Un parametro è simile a un'intestazione, con le seguenti differenze:
  • I parametri contengono dati effettivi e sono disponibili per gli utenti finali, le intestazioni contengono metadati associati a una richiesta o risposta e sono nascosti agli utenti finali.
  • Un parametro può avere diverse ubicazioni, la posizione di un'intestazione è sempre impostata su header.
  • Un parametro può avere vari stili di formato, lo stile di un'intestazione è sempre simple.

In qualsiasi momento puoi passare direttamente al codice sorgente YAML sottostante dell' OpenAPI, cliccando Icona origine OpenAPI sull'icona "Sorgente". Per tornare al modulo di progettazione, clicca sull'icona Icona moduloModulo.

Procedura

  1. Fornisci le seguenti informazioni:
    • Descrizione: una descrizione del parametro. È possibile utilizzare la sintassi CommonMark per la rappresentazione in formato RTF.
    • Tipo: il tipo di dati del parametro.
    • Formato: selezionare il formato dei dati; le opzioni disponibili dipendono dal Tiposelezionato.
    • Seleziona le seguenti opzioni come necessario:
      • Obbligatorio: determina se questo parametro è obbligatorio. Se la proprietà Located In è impostata su path, questa opzione deve essere selezionata.
      • Consenti valore vuoto: consente di inviare un parametro con un valore vuoto. Ciò è valido solo se la proprietà Located In è impostata su query.
  2. Fare clic su Salva una volta terminato.

Cosa fare successivamente

Se necessario, utilizzare la traccia breadcrumb per passare a un'altra posizione nella gerarchia dell'oggetto su cui si sta lavorando.