Definición de componentes de cuerpo de solicitud

Un componente de cuerpo de solicitud es una definición reutilizable de la estructura del cuerpo de una solicitud de API.

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.

En cualquier momento, puedes pasar directamente al código fuente YAML de « OpenAPI » haciendo clic Icono OpenAPI Source en el icono «Fuente ». Para volver al formulario de diseño, haz clic en el icono del 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 cuerpo de solicitud definidos, expanda Cuerpos de solicitud.
  3. Puede crear un componente de cuerpo de solicitud o editar cualquier componente de cuerpo de solicitud existente.
    • Para crear un componente del cuerpo de la solicitud, haz clic en el icono de añadir OpenAPI 3.0 Icono de adición de API situado junto a «Cuerpos de solicitud » y, a continuación, consulta la sección «Creación de un cuerpo de solicitud ».
    • Para editar un componente del cuerpo de la solicitud ya existente, haz clic en el nombre del componente en el panel de navegación y, a continuación, consulta la sección «Edición del cuerpo de la solicitud ».