Definizione dei componenti di intestazione

Modifica online

Un componente di intestazione definisce un'intestazione personalizzata riutilizzabile che può essere inviata in una richiesta API o restituita in una risposta API.

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.

Per utilizzare un componente di intestazione, devi fare riferimento ad esso da un'altra parte nella tua definizione API.

Un'intestazione è simile a un parametro, 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 sui parametri, consultare Creazione di un parametro.

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 Componenti quindi, se sono già definiti uno o più componenti di intestazione, espandere Intestazioni.
È possibile creare un nuovo componente di intestazione o modificare qualsiasi componente di intestazione esistente.
- Per creare un componente di intestazione, clicca sull'icona di aggiunta accanto alla voce "Intestazioni", quindi consulta la sezione "Creazione di un'intestazione".
- Per modificare un componente di intestazione esistente, fare clic sul nome del componente nel riquadro di navigazione, quindi consultare la sezione Modifica di un'intestazione.