Creación de una cabecera

Una cabecera define información que puede enviarse en una solicitud de API o devolverse en una respuesta de API. Puede crear cabeceras en diversos lugares de la definición de API.

Antes de empezar

Abra la ventana de creación de cabeceras. Para obtener detalles de las áreas de la definición de API donde puede crear una cabecera, consulte los temas siguientes:

Acerca de esta tarea

Nota:

Esta tarea está relacionada con la configuración de una definición de API OpenAPI 3.0. Para obtener detalles sobre cómo configurar una definición de API de OpenAPI 2.0 , consulte Edición de una definición de API de OpenAPI 2.0.
Las API de OpenAPI 3.0 solo están soportadas con DataPower® API Gateway, no con DataPower Gateway (v5 compatible).
Para obtener detalles sobre las limitaciones actuales del soporte de OpenAPI 3.0 , consulte el soporte de OpenAPI 3.0 en IBM® API Connect.

Puede completar esta tarea utilizando la aplicación de interfaz de usuario de API Designer o utilizando la interfaz de usuario de API Manager basada en navegador.

Una cabecera es similar a un parámetro, con las diferencias siguientes:

Los parámetros transportan datos reales y están disponibles para los usuarios finales, mientras que las cabeceras transportan metadatos asociados con una solicitud o respuesta y están ocultas a los usuarios finales.
Un parámetro puede tener varias ubicaciones, mientras que la ubicación de una cabecera se establece siempre en header.
Un parámetro puede tener varios estilos de formato, mientras que el estilo de una cabecera es siempre simple.

Para obtener más información sobre los parámetros, consulte Creación de un parámetro.

En cualquier momento, puede conmutar directamente al origen YAML OpenAPI subyacente pulsando el icono Origen Icono OpenAPI Source . Para volver al formulario de diseño, pulse el icono Formulario Icono de formulario .

Procedimiento

Cree la cabecera; puede crear una cabecera desde cero o hacer referencia a una cabecera que esté definida en un componente de cabecera.
- Para crear la cabecera desde cero, especifique la información siguiente en la pestaña Definición:
  - Nombre de cabecera: si está creando un componente de cabecera, este nombre define una clave que permite hacer referencia a esta cabecera desde otra ubicación de la definición de API; la referencia tiene el formato siguiente:
```
#/components/headers/Name
```
  - Descripción: una descripción de la cabecera. Puede utilizar la sintaxis CommonMark para la representación de texto enriquecido.
  - Necesaria: determina si esta cabecera es obligatoria.
  - En desuso: especifica que esta cabecera está en desuso y debe pasar a no utilizada.
  - Permitir valor vacío: la cabecera puede enviarse con un valor vacío.
  - Explosión: si se selecciona, los valores de cabecera de tipo array u object generan cabeceras separadas para cada valor de la matriz o par de clave-valor de la correlación.
  - Permitir reservado: determina si el valor de cabecera debe permitir que los caracteres reservados, tal como se define en RFC3986 (:/?#[]@!$&'()*+,;=), se incluyan sin codificación de porcentaje.
- Para hacer referencia a una cabecera que está definida en un componente de cabecera, especifique la información siguiente en la pestaña Referencia:
  - Nombre de cabecera: si está creando un componente de cabecera, este nombre define una clave que permite hacer referencia a esta cabecera desde otra ubicación de la definición de API; la referencia tiene el formato siguiente:
```
#/components/headers/Name
```
  - Referencia desde: seleccione una referencia a un componente de cabecera.
Pulse Crear.
Los detalles de cabecera se muestran para su posterior edición; consulte Edición de una cabecera.