Definición del cuerpo de solicitud de una operación

Un cuerpo de solicitud define 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, 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.

Nota: La interfaz de usuario no da soporte actualmente a la referencia a un componente de cuerpo de solicitud desde una operación. Sin embargo, puede añadir la referencia directamente al código fuente YAML de OpenAPI de la definición de API, por ejemplo:
paths:
  /mypath:
    get:
          .
          .
          .
      requestBody:
        $ref: '#/components/requestBodies/my_requestbody_component'
          .
          .
          .

Para obtener información sobre los componentes de cuerpo de solicitud, consulte Definición de componentes de cuerpo de solicitud.

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 Vías de accesoy, a continuación, expanda la vía de acceso necesaria.
  3. Expanda Operaciones, expanda la operación necesaria y, a continuación, pulse requestBody.
  4. Especifique la información siguiente:
    • Descripción: descripción opcional del cuerpo de solicitud. Podría contener ejemplos de uso. Puede utilizar la sintaxis CommonMark para la representación de texto enriquecido.
    • Contenido: una definición de contenido describe el contenido del cuerpo de solicitud.

      Para definir una nueva definición de contenido para el cuerpo de solicitud, pulse Añadiry, a continuación, consulte Creación de una definición de contenido.

      Para editar una definición de contenido existente, pulse el nombre de definición de contenido y, a continuación, consulte Edición de una definición de contenido.

    • Necesario: determina si el cuerpo de solicitud es necesario en la solicitud.
  5. Haga clic en Guardar cuando haya terminado.