Definición de componentes de parámetro

Los componentes de parámetro definen parámetros reutilizables que pueden especificar elementos variables de una vía de acceso de URL, parámetros de consulta, cabeceras o un cuerpo de solicitud.

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.

Para utilizar un componente de parámetro, debe hacer referencia a él desde otra ubicación de la definición de API.

Un parámetro es similar a una cabecera, 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 las cabeceras, consulte Creación de una cabecera.

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

  1. Abra la API para editarla, tal como se describe en Edición de una definición de API de OpenAPI 3.0.
  2. Expanda Componentes y, a continuación, si ya hay uno o más componentes de parámetro definidos, expanda Parámetros.
  3. Puede crear un componente de parámetro o editar cualquier componente de parámetro existente.
    • Para crear un componente de parámetro, pulse el icono Añadir OpenAPI 3.0 Icono de adición de API junto a Parámetrosy, a continuación, consulte Creación de un parámetro.
    • Para editar un componente de parámetro existente, pulse el nombre del componente de parámetro en el panel de navegación y, a continuación, consulte Edición de un parámetro.