Definición de componentes de ejemplo

Un componente de ejemplo es un ejemplo reutilizable que puede añadirse a una API para clarificar la especificación de la 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.

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

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 varios componentes de ejemplo definidos, expanda Ejemplos.
  3. Puede crear un componente de ejemplo o editar cualquier componente de ejemplo existente.
    • Para crear un componente de ejemplo, pulse el icono Añadir OpenAPI 3.0 Icono de adición de API junto a Ejemplosy, a continuación, consulte Creación de un ejemplo.
    • Para editar un componente de ejemplo existente, pulse el nombre del componente de ejemplo en el panel de navegación y, a continuación, consulte Edición de un ejemplo.