Definizione di parametri per un'operazione

Modifica online

I parametri operativi possono, per il percorso dell' URL e associato a quella specifica operazione, definire elementi variabili del percorso dell' URL e, parametri di query, intestazioni o parametri del corpo.

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.

Un parametro dell'operazione ha la precedenza su un parametro con lo stesso nome definito nel percorso padre; vedere Definizione dei parametri per un percorso.

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.

Per ulteriori informazioni sulle intestazioni, consultare Creazione di un'intestazione.

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 modulo Modulo.

Procedura

Apri l'API per la modifica, come descritto in Modifica di una definizione API OpenAPI 3.0.
espandere Percorsi, quindi espandere il percorso richiesto.
Espandere Operazioni, quindi espandere l'operazione richiesta.
È possibile creare un nuovo parametro di operazione o modificare qualsiasi parametro esistente.
- Per creare un parametro di operazione, fare clic sull'icona di aggiunta accanto a "Parametro ", quindi consultare la sezione "Creazione di un parametro ".
- Per modificare un parametro di operazione esistente, fare clic sul nome del parametro nel riquadro di navigazione, quindi consultare la sezione Modifica di un parametro.