Creazione di un'intestazione

Un'intestazione definisce le informazioni che possono essere inviate in una richiesta API o restituite in una risposta API. È possibile creare intestazioni in varie posizioni nella definizione API.

Prima di iniziare

Avviare la finestra di creazione dell'intestazione. Per i dettagli delle aree nella tua definizione API da cui puoi creare un'intestazione, consulta i seguenti argomenti:

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'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 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

Creare l'intestazione; è possibile creare un'intestazione da zero oppure è possibile fare riferimento a un'intestazione definita in un componente intestazione.
- Per creare l'intestazione da zero, fornire le seguenti informazioni nella pagina Definizione :
  - Nome intestazione: se si sta creando un componente intestazione, questo nome definisce una chiave che consente a questa intestazione di fare riferimento da un'altra parte nella definizione dell'API; il riferimento ha il formato seguente:
```
#/components/headers/Name
```
  - Descrizione: una descrizione dell'intestazione. È possibile utilizzare la sintassi CommonMark per la rappresentazione rich text.
  - Obbligatorio: determina se questa intestazione è obbligatoria.
  - Obsoleto: specifica che questa intestazione è obsoleta e deve essere eliminata dall'utilizzo.
  - Consenti valore vuoto: l'intestazione può essere inviata con un valore vuoto.
  - Esplodi: quando selezionato, i valori di intestazione di tipo array o object generano intestazioni separate per ogni valore della coppia di valori chiave o array della mappa.
  - Consenti riservato: determina se il valore dell'intestazione deve consentire caratteri riservati, come definito da RFC3986 (:/?#[]@!$&'()*+,;=) da includere senza codifica percentuale.
- Per fare riferimento a un'intestazione definita in un componente intestazione, fornire le seguenti informazioni nella scheda Riferimento :.
  - Nome intestazione: se si sta creando un componente intestazione, questo nome definisce una chiave che consente a questa intestazione di fare riferimento da un'altra parte nella definizione dell'API; il riferimento ha il formato seguente:
```
#/components/headers/Name
```
  - Riferimento da: selezionare un riferimento ad un componente intestazione.
Fare clic su Crea.
I dettagli dell'intestazione vengono visualizzati per un'ulteriore modifica; consultare Modifica di un'intestazione.